pyradtran.config.CloudParameters

class pyradtran.config.CloudParameters(enabled: bool = False, cloud_type: str = 'wc', cloud_source: str = 'parametric', layer_bottom_km: float = 1.0, layer_top_km: float = 2.0, water_content_g_m3: float = 0.1, ice_content_g_m3: float = 0.0, effective_radius_um: float = 10.0, cloud_fraction: float = 1.0, wc_file: Path | None = None, ic_file: Path | None = None, era5_dataset: Any | None = None, era5_time: str | None = None, era5_lat: float | None = None, era5_lon: float | None = None)

Bases: object

Declarative cloud settings used inside SimulationDefaults.

Three cloud_source modes are supported:

"parametric"

A single homogeneous slab defined by layer_bottom_km, layer_top_km, water_content_g_m3, etc.

"file"

Pre-computed cloud profile(s) on disk (wc_file, ic_file).

"era5"

Auto-generated from an ERA5 dataset at run time.

Parameters:

• enabled (bool, default False) – Enable cloud handling.

• cloud_type ({“wc”, “ic”, “mixed”}, default "wc") – Cloud phase.

• cloud_source ({“parametric”, “file”, “era5”}, default "parametric") – How the cloud profile is supplied.

• layer_bottom_km (float) – Vertical extent of the parametric slab (km).

• layer_top_km (float) – Vertical extent of the parametric slab (km).

• water_content_g_m3 (float) – Mass content (g m⁻³).

• ice_content_g_m3 (float) – Mass content (g m⁻³).

• effective_radius_um (float, default 10.0) – Effective droplet / crystal radius (µm).

• cloud_fraction (float, default 1.0) – Cloud fraction (0–1).

• wc_file (pathlib.Path, optional) – Paths for file-based clouds.

• ic_file (pathlib.Path, optional) – Paths for file-based clouds.

• era5_dataset (any, optional) – Not serialisable in YAML; set at run time.

• era5_time (str or float, optional) – Selection parameters for the ERA5 source.

• era5_lat (str or float, optional) – Selection parameters for the ERA5 source.

• era5_lon (str or float, optional) – Selection parameters for the ERA5 source.

See also

pyradtran.clouds.CloudGenerator

Programmatic cloud-layer creation.

__init__(enabled: bool = False, cloud_type: str = 'wc', cloud_source: str = 'parametric', layer_bottom_km: float = 1.0, layer_top_km: float = 2.0, water_content_g_m3: float = 0.1, ice_content_g_m3: float = 0.0, effective_radius_um: float = 10.0, cloud_fraction: float = 1.0, wc_file: Path | None = None, ic_file: Path | None = None, era5_dataset: Any | None = None, era5_time: str | None = None, era5_lat: float | None = None, era5_lon: float | None = None) → None

__init__([enabled, cloud_type, ...])
cloud_fraction
cloud_source
cloud_type
effective_radius_um
enabled
era5_dataset
era5_lat
era5_lon
era5_time
ic_file
ice_content_g_m3
layer_bottom_km
layer_top_km
water_content_g_m3
wc_file

cloud_fraction: float = 1.0

cloud_source: str = 'parametric'

cloud_type: str = 'wc'

effective_radius_um: float = 10.0

enabled: bool = False

era5_dataset: Any | None = None

era5_lat: float | None = None

era5_lon: float | None = None

era5_time: str | None = None

ic_file: Path | None = None

ice_content_g_m3: float = 0.0

layer_bottom_km: float = 1.0

layer_top_km: float = 2.0

water_content_g_m3: float = 0.1

wc_file: Path | None = None