[data] DataManagersConfig

TOML section: [data]

Pydantic model: DataManagersConfig defined in hydromodpy.data.managers.config_schema.

Source on GitHub

Top-level [data] configuration for manager families.

The types list declares user-requested data families. The effective active set can also include planner-inferred families deduced from other sections (domain, flow) depending on inference_mode.

For each active type, the matching nested section can be validated dynamically: - geology already uses its dedicated Pydantic model (GeologyConfig), - oceanic uses OceanicConfig, - the other data families are kept as validated mappings for now.

Use this model for validation only. Runtime activation order is represented by DataLoadPlan and loaded by DataManagersRuntimeLoader.

Show fields: User User + Dev All

Fields

project_crs

str | None default = None user source

EPSG code or WKT string of the project coordinate reference system. When set, all loaded data is reprojected to this CRS. Example: ‘EPSG:2154’ (Lambert-93).

types

list[str] factory user source

Ordered list of data-manager types explicitly requested in [data]. The launcher may append inferred types deduced from other sections (for example domain.zone_ids, flow.active_bc). Allowed values: ‘dem’, ‘etp’, ‘geology’, ‘humidity’, ‘hydrography’, ‘hydrometry’, ‘intermittency’, ‘lake_abacus’, ‘lake_bathymetry’, ‘lake_geometry’, ‘lake_inflow’, ‘lake_levels’, ‘lake_outflow’, ‘lake_withdrawal’, ‘oceanic’, ‘piezometry’, ‘precipitation’, ‘radiation’, ‘recharge’, ‘runoff’, ‘soil_moisture’, ‘temperature’, ‘water_quality’, ‘wind’.

inference_mode

str default = “warn” dev source

Policy applied when the planner infers types not explicitly listed in data.types. ‘warn’: keep inferred types and continue even if data.<type> is missing. ‘strict’: raise when an inferred type has no explicit data.<type> section (except geology, which can use its default typed config).

One of: "warn" "strict"

dem in TOML: [data.dem]

DemConfig | None default = None user source

DEM configuration used when ‘dem’ is listed in data.types.

Fields of DemConfig

sources in TOML: [[data.dem.sources]]

source = “custom” | “ign_geoplateforme_dem” required user source

At least one DEM data source.

Pick a tab below: setting source selects the matching schema.

custom

TOML: [[data.dem.sources]] with source = "custom" – model CustomDemSource.

mask_path

Path | None default = None user source

SHP/GPKG/GeoJSON mask for spatial filtering/clipping.

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore cache and re-download from API.

path

Path required user source

Path to custom DEM file or directory (TIF, ASC, NC).

ign_geoplateforme_dem

TOML: [[data.dem.sources]] with source = "ign_geoplateforme_dem" – model IgnGeoplateformeDemSource.

mask_path

Path | None default = None user source

SHP/GPKG/GeoJSON mask for spatial filtering/clipping.

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore cache and re-download from API.

departments

list[str] factory user source

Optional French department codes to fetch. When set, these codes constrain archive downloads instead of inferring departments only from the bbox.

country

str default = “FR” user source

Country code used for administrative DEM selectors.

regions

list[str] factory user source

Optional French administrative regions used to infer department downloads.

dataset

Literal[‘bd-alti’] default = “bd-alti” user source

IGN DEM product assembled by the data manager. Only BD ALTI 25 m is currently exposed as an assembled raster source; use the download_dem_fr helper to inspect raw RGE ALTI archives.

resolution_m

float | None default = None user source

Requested DEM resolution in metres. Defaults are resolved by the manager from the selected dataset.

file_format

str default = “ASC” user source

Requested archive payload format when exposed by Geoplateforme.

crs

str | None default = None user source

Optional CRS filter forwarded to Geoplateforme discovery.

geology in TOML: [data.geology]

GeologyConfig | None default = None user source

Geology configuration used when ‘geology’ is listed in data.types.

Fields of GeologyConfig

sources in TOML: [[data.geology.sources]]

source = “custom” | “brgm_1m” | “brgm_50k” factory user source

At least one geology data source. Defaults to BRGM 1:1M.

Pick a tab below: setting source selects the matching schema.

custom

TOML: [[data.geology.sources]] with source = "custom" – model CustomGeologySource.

mask_path

Path | None default = None user source

SHP/GPKG/GeoJSON mask for spatial filtering/clipping.

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore cache and re-download from API.

path

Path required user source

Path to custom geology file or directory (SHP, GPKG, TIF, CSV).

code_field

str | None default = None user source

Attribute column for geology codes in custom vector files (SHP/GPKG). Required for custom vector sources.

values_table_path

Path | None default = None user source

Optional CSV linking geology codes to descriptions. Columns: geology_code, description.

col_x

str default = “x” dev source

Column for X coordinate in CSV.

col_y

str default = “y” dev source

Column for Y coordinate in CSV.

col_code

str default = “geology_code” dev source

Column for geology code in CSV.

default_crs

str default = “EPSG:2154” dev source

Default CRS for CSV points.

brgm_1m

TOML: [[data.geology.sources]] with source = "brgm_1m" – model BrgmGeology1mSource.

mask_path

Path | None default = None user source

SHP/GPKG/GeoJSON mask for spatial filtering/clipping.

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore cache and re-download from API.

brgm_50k

TOML: [[data.geology.sources]] with source = "brgm_50k" – model BrgmGeology50kSource.

mask_path

Path | None default = None user source

SHP/GPKG/GeoJSON mask for spatial filtering/clipping.

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore cache and re-download from API.

id

str default = “field_geology” user source

Identifier of the geology spatial field.

cell_samples_per_axis

int default = 8 dev source

Sub-sampling density for GeologyField.on_mesh(). Higher = more precise geology interface, slower runtime.

hydrography in TOML: [data.hydrography]

HydrographyConfig | None default = None user source

Hydrography configuration (stream network vector data).

Fields of HydrographyConfig

sources in TOML: [[data.hydrography.sources]]

list[HydrographySourceConfig] required user source

At least one hydrography data source.

Fields of HydrographySourceConfig

source

str required user source

Data provider.

"custom"

Loads a river network from a local vector or raster file you provide.

"osm"

Downloads waterway geometries from OpenStreetMap.

"bdtopage"

Downloads the French BD Topage reference network from the Sandre WFS.

"euhydro"

Downloads the EEA EU-Hydro continental-scale river network.

path

Path | None default = None user source

Path to a vector file (SHP/GPKG/GeoJSON), raster (TIF/TIFF), or directory containing one.

rasterize_field

str default = “FID” user source

Attribute field used when rasterising the vector layer.

typename

str default = “sa:CoursEau_FXX_Topage2025” dev source

WFS typename for BD Topage.

page_size

int default = 2000 dev source

WFS pagination page size (BD Topage).

group_name

str default = “River_Net_lines” dev source

MapServer group name for EU-Hydro layer discovery.

euhydro_page_size

int default = 1000 dev source

Pagination page size for EU-Hydro REST queries.

force_refresh

bool default = False dev source

Bypass API cache and re-download data.

waterway_types

list[str] factory dev source

OSM waterway tag values to fetch.

hydrometry in TOML: [data.hydrometry]

HydrometryConfig | None default = None user source

Hydrometry configuration (discharge time-series).

Fields of HydrometryConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.hydrometry.sources]]

list[HydrometrySourceConfig] required user source

At least one data source.

Fields of HydrometrySourceConfig

fallback_search_radius_km

float | None default = None dev source

Maximum search radius (km) used to find a fallback station when no observation is available inside the requested bbox.

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

str required user source

Data provider: ‘custom’ for user files, ‘hubeau’ for Hub’Eau API.

One of: "custom" "hubeau"

path

Path | None default = None user source

Directory containing location file and chronicle CSVs.

product

str | None default = None user source

Hub’Eau variable code (e.g. ‘QmnJ’, ‘QmM’, ‘HmnJ’).

require_observations

bool default = True dev source

Drop stations whose declared service period does not overlap the requested window, before downloading them. It is a metadata filter: a station that overlaps but returns nothing is dropped after its download instead, and the run says which ones.

max_stations

int | None default = None user source

Maximum number of Hub’Eau stations to KEEP. Stations that return no observation in the window do not count against it, so a preview run over a larger territory gets this many stations carrying data, not this many tried.

intermittency in TOML: [data.intermittency]

IntermittencyConfig | None default = None user source

Intermittency configuration (ONDE stream flow-state observations).

Fields of IntermittencyConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.intermittency.sources]]

list[IntermittencySourceConfig] required user source

At least one data source.

Fields of IntermittencySourceConfig

fallback_search_radius_km

float | None default = None dev source

Maximum search radius (km) used to find a fallback station when no observation is available inside the requested bbox.

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

str required user source

Data provider: ‘custom’ for user files, ‘hubeau’ for Hub’Eau stream-flow API.

One of: "custom" "hubeau"

path

Path | None default = None user source

Directory containing location file and chronicle CSVs.

code_departement

list[str] | None default = None user source

INSEE department codes to filter Hub’Eau station discovery.

require_observations

bool default = True dev source

Only keep stations that have observations in the period.

lake_abacus in TOML: [data.lake_abacus]

LakeAbacusConfig | None default = None user source

Lake abacus configuration (stage-volume-area lookup table).

Fields of LakeAbacusConfig

sources in TOML: [[data.lake_abacus.sources]]

list[CustomLakeAbacusSource] required user source

At least one lake-abacus data source.

Fields of CustomLakeAbacusSource

source

Literal[‘custom’] default = “custom” user source

Discriminator tag selecting the ‘custom’ lake-abacus provider.

path

Path required user source

Path to a custom lake-abacus table file (CSV with stage,volume,sarea).

lake_id

str | None default = None user source

Lake identifier injected into the table when the file omits a lake_id column.

id

str default = “lake_abacus” user source

Identifier of the lake-abacus table.

lake_bathymetry in TOML: [data.lake_bathymetry]

LakeBathymetryConfig | None default = None user source

Lake bathymetry configuration (lake-bed elevation raster).

Fields of LakeBathymetryConfig

sources in TOML: [[data.lake_bathymetry.sources]]

list[CustomLakeBathymetrySource] required user source

At least one lake-bathymetry data source.

Fields of CustomLakeBathymetrySource

source

Literal[‘custom’] default = “custom” user source

Discriminator tag selecting the ‘custom’ lake-bathymetry provider.

path

Path required user source

Path to a custom lake-bathymetry raster file (GeoTIFF, ASC).

default_crs

str default = “EPSG:2154” user source

Fallback CRS used only when the raster carries none of its own. Defaults to RGF93/Lambert-93 (EPSG:2154); set it to the site CRS for a non-French dataset.

id

str default = “lake_bathymetry” user source

Identifier of the lake-bathymetry spatial field.

lake_geometry in TOML: [data.lake_geometry]

LakeGeometryConfig | None default = None user source

Lake geometry configuration (lake/reservoir footprint vector).

Fields of LakeGeometryConfig

sources in TOML: [[data.lake_geometry.sources]]

list[CustomLakeGeometrySource] required user source

At least one lake-geometry data source.

Fields of CustomLakeGeometrySource

source

Literal[‘custom’] default = “custom” user source

Discriminator tag selecting the ‘custom’ lake-geometry provider.

path

Path required user source

Path to a custom lake-geometry vector file (SHP, GPKG, GeoJSON).

default_crs

str default = “EPSG:2154” user source

Fallback CRS used only when the file carries none of its own. Defaults to RGF93/Lambert-93 (EPSG:2154); set it to the site CRS for a non-French dataset.

id

str default = “lake_geometry” user source

Identifier of the lake-geometry spatial field.

lake_inflow in TOML: [data.lake_inflow]

LakeInflowConfig | None default = None user source

Lake inflow configuration (observed inflow volumetric time series).

Fields of LakeInflowConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.lake_inflow.sources]]

list[LakeInflowSourceConfig] required user source

At least one lake-inflow data source.

Fields of LakeInflowSourceConfig

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

Literal[‘custom’] required user source

Data provider: ‘custom’ for user files.

path

Path | None default = None user source

Directory containing location file and chronicle CSVs.

lake_levels in TOML: [data.lake_levels]

LakeLevelsConfig | None default = None user source

Lake levels configuration (observed water-level time series).

Fields of LakeLevelsConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.lake_levels.sources]]

list[LakeLevelsSourceConfig] required user source

At least one lake-levels data source.

Fields of LakeLevelsSourceConfig

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

Literal[‘custom’] required user source

Data provider: ‘custom’ for user files.

path

Path | None default = None user source

Directory containing location file and chronicle CSVs.

lake_outflow in TOML: [data.lake_outflow]

LakeOutflowConfig | None default = None user source

Lake outflow configuration (observed outflow volumetric time series).

Fields of LakeOutflowConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.lake_outflow.sources]]

list[LakeOutflowSourceConfig] required user source

At least one lake-outflow data source.

Fields of LakeOutflowSourceConfig

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

Literal[‘custom’] required user source

Data provider: ‘custom’ for user files.

path

Path | None default = None user source

Directory containing location file and chronicle CSVs.

lake_withdrawal in TOML: [data.lake_withdrawal]

LakeWithdrawalConfig | None default = None user source

Lake withdrawal configuration (observed withdrawal volumetric time series).

Fields of LakeWithdrawalConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.lake_withdrawal.sources]]

list[LakeWithdrawalSourceConfig] required user source

At least one lake-withdrawal data source.

Fields of LakeWithdrawalSourceConfig

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

Literal[‘custom’] required user source

Data provider: ‘custom’ for user files.

path

Path | None default = None user source

Directory containing location file and chronicle CSVs.

oceanic in TOML: [data.oceanic]

OceanicConfig | None default = None user source

Oceanic configuration used when ‘oceanic’ is listed in data.types.

Fields of OceanicConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.oceanic.sources]]

list[OceanicSourceConfig] required user source

At least one data source.

Fields of OceanicSourceConfig

fallback_search_radius_km

float | None default = None dev source

Maximum search radius (km) used to find a fallback station when no observation is available inside the requested bbox.

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

str required user source

Data provider: ‘custom’ for user CSV/NC/TIF files, ‘shom’ for SHOM API, ‘constant’ for fixed MSL.

One of: "custom" "shom" "constant"

path

Path | None default = None user source

Directory containing location file and chronicle CSVs, or a single .nc/.tif file.

value

float | None default = None user source

Constant mean sea-level value in metres.

nearest

bool default = True dev source

Use nearest tide gauge to watershed centroid.

require_observations

bool default = True dev source

Raise if SHOM returns no observations.

piezometry in TOML: [data.piezometry]

PiezometryConfig | None default = None user source

Piezometry configuration (groundwater level time-series).

Fields of PiezometryConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.piezometry.sources]]

list[PiezometrySourceConfig] required user source

At least one data source.

Fields of PiezometrySourceConfig

fallback_search_radius_km

float | None default = None dev source

Maximum search radius (km) used to find a fallback station when no observation is available inside the requested bbox.

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

str required user source

Data provider.

"custom"

Loads groundwater-level records from local station and chronicle files.

"hubeau"

Downloads public groundwater-level observations from the Hub’Eau API.

path

Path | None default = None user source

Directory containing location file and chronicle CSVs.

product

Optional[str] default = None user source

Hub’Eau measurement type: ‘level’ or ‘depth’.

One of: "level" "depth"

require_observations

bool default = True dev source

Only keep stations that have observations in the period.

nearest

bool default = False dev source

Keep only the nearest piezometer to the extent centroid.

water_quality in TOML: [data.water_quality]

WaterQualityConfig | None default = None user source

Water quality configuration (physico-chemical parameters).

Fields of WaterQualityConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.water_quality.sources]]

list[WaterQualitySourceConfig] required user source

At least one data source.

Fields of WaterQualitySourceConfig

fallback_search_radius_km

float | None default = None dev source

Maximum search radius (km) used to find a fallback station when no observation is available inside the requested bbox.

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

str required user source

Data provider: ‘custom’ for user files, ‘hubeau’ for Hub’Eau API.

One of: "custom" "hubeau"

site_type

str default = “river” user source

Type of site: ‘river’ (qualite_rivieres) or ‘piezometer’ (qualite_nappes).

One of: "river" "piezometer"

parameters

list[str] | None default = None user source

Parameters to keep (e.g. [‘pH’, ‘Nitrates’]). None = all parameters.

path

Path | None default = None user source

Directory containing location file and chronicle CSVs.

nearest

bool default = False dev source

Keep only the nearest station to the extent centroid.

recharge in TOML: [data.recharge]

RechargeConfig | None default = None user source

Recharge configuration (drainage / soil infiltration time series).

Fields of RechargeConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.recharge.sources]]

list[RechargeSourceConfig] required user source

At least one data source.

Fields of RechargeSourceConfig

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip grid.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. If omitted for NetCDF, units are inferred from variable metadata when available.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

str required user source

Data provider: ‘custom’ for user CSV files, ‘sim2’ for SIM2 EDR API, ‘synthetic’ for generated series.

One of: "custom" "sim2" "synthetic"

path

Path | None default = None user source

Directory containing location file and chronicle CSVs, or a single .nc/.tif file.

values

list[float] | None default = None user source

Recharge values in mm/day. Single value for constant, list for time-varying.

start_date

str | None default = None user source

Start date for synthetic series (ISO format, e.g. ‘2020-01-01’).

freq

str | None default = None dev source

Frequency for synthetic series (e.g. ‘D’, ‘ME’, ‘YE’).

periods

int | None default = None dev source

Number of periods for synthetic series.

amplitude

float | None default = None expert source

Sinusoidal amplitude in mm/day (superimposed on values).

period_days

int | None default = None expert source

Sinusoidal period in days.

offset

float | None default = None expert source

Sinusoidal baseline offset in mm/day.

runoff_ratio

float | None default = None dev source

Fraction of recharge routed to runoff (0.0 to 1.0).

runoff in TOML: [data.runoff]

RunoffConfig | None default = None user source

Runoff configuration (surface runoff time series).

Fields of RunoffConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.runoff.sources]]

list[RunoffSourceConfig] required user source

At least one data source.

Fields of RunoffSourceConfig

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

str required user source

Data provider: ‘custom’ for user CSV files, ‘sim2’ for SIM2 EDR API.

One of: "custom" "sim2"

path

Path | None default = None user source

Directory containing location file and chronicle CSVs, or a single .nc/.tif file.

precipitation in TOML: [data.precipitation]

PrecipitationConfig | None default = None user source

Precipitation configuration (liquid and solid precipitation).

Fields of PrecipitationConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.precipitation.sources]]

list[PrecipitationSourceConfig] required user source

At least one data source.

Fields of PrecipitationSourceConfig

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

str required user source

Data provider: ‘custom’ for user CSV files, ‘sim2’ for SIM2 EDR API.

One of: "custom" "sim2"

components

list[str] default = [‘total’] user source

Precipitation components: ‘liquid’ (rain), ‘solid’ (snow), ‘total’ (sum of both).

One of: "liquid" "solid" "total"

path

Path | None default = None user source

Directory containing location file and chronicle CSVs, or a single .nc/.tif file.

etp in TOML: [data.etp]

EtpConfig | None default = None user source

ETP configuration (potential evapotranspiration).

Fields of EtpConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.etp.sources]]

list[EtpSourceConfig] required user source

At least one data source.

Fields of EtpSourceConfig

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

str required user source

Data provider: ‘custom’ for user CSV files, ‘sim2’ for SIM2 EDR API.

One of: "custom" "sim2"

path

Path | None default = None user source

Directory containing location file and chronicle CSVs, or a single .nc/.tif file.

crs

str | None default = None user source

Optional CRS fallback for custom gridded NetCDF inputs that do not declare CRS metadata.

nodata

float | int | str | None default = None user source

Optional nodata fallback for custom gridded NetCDF inputs that do not declare nodata metadata.

temperature in TOML: [data.temperature]

TemperatureConfig | None default = None user source

Temperature configuration (air temperature time series).

Fields of TemperatureConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.temperature.sources]]

list[TemperatureSourceConfig] required user source

At least one data source.

Fields of TemperatureSourceConfig

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

str required user source

Data provider: ‘custom’ for user CSV files, ‘sim2’ for SIM2 EDR API.

One of: "custom" "sim2"

path

Path | None default = None user source

Directory containing location file and chronicle CSVs, or a single .nc/.tif file.

wind in TOML: [data.wind]

WindConfig | None default = None user source

Wind configuration (wind speed time series).

Fields of WindConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.wind.sources]]

list[WindSourceConfig] required user source

At least one data source.

Fields of WindSourceConfig

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

str required user source

Data provider: ‘custom’ for user CSV files, ‘sim2’ for SIM2 EDR API.

One of: "custom" "sim2"

path

Path | None default = None user source

Directory containing location file and chronicle CSVs, or a single .nc/.tif file.

humidity in TOML: [data.humidity]

HumidityConfig | None default = None user source

Humidity configuration (relative humidity time series).

Fields of HumidityConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.humidity.sources]]

list[HumiditySourceConfig] required user source

At least one data source.

Fields of HumiditySourceConfig

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

str required user source

Data provider: ‘custom’ for user CSV files, ‘sim2’ for SIM2 EDR API.

One of: "custom" "sim2"

path

Path | None default = None user source

Directory containing location file and chronicle CSVs, or a single .nc/.tif file.

radiation in TOML: [data.radiation]

RadiationConfig | None default = None user source

Radiation configuration (atmospheric and visible radiation).

Fields of RadiationConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.radiation.sources]]

list[RadiationSourceConfig] required user source

At least one data source.

Fields of RadiationSourceConfig

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

str required user source

Data provider: ‘custom’ for user CSV files, ‘sim2’ for SIM2 EDR API.

One of: "custom" "sim2"

components

list[str] default = [‘atmospheric’, ‘visible’] user source

Radiation components: ‘atmospheric’ (DLI_Q) and/or ‘visible’ (SSI_Q).

One of: "atmospheric" "visible"

path

Path | None default = None user source

Directory containing location file and chronicle CSVs, or a single .nc/.tif file.

soil_moisture in TOML: [data.soil_moisture]

SoilMoistureConfig | None default = None user source

Soil moisture configuration (soil moisture index).

Fields of SoilMoistureConfig

date_start

str | None default = None user source

Start of the data window (ISO date, e.g. ‘2019-01-01’). Optional: when neither bound is declared, the loader inherits [simulation.time].start_datetime, or [overview].date_start in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the data window (ISO date, e.g. ‘2025-12-31’). Optional: when neither bound is declared, the loader inherits [simulation.time].end_datetime, or [overview].date_end in overview mode. Declare it only to fetch a window WIDER than the simulation, typically a cache shared by several runs. Must be declared together with date_start.

Example: "2025-12-31"

sources in TOML: [[data.soil_moisture.sources]]

list[SoilMoistureSourceConfig] required user source

At least one data source.

Fields of SoilMoistureSourceConfig

station_ids

list[str] | None default = None user source

Explicit station identifiers to load (custom source).

extent

Optional[str] default = None dev source

Retrieve on the project extent rather than on this source’s own filters. Only whether it is SET matters to the loaders; the two literals are told apart by the site-selection pipeline alone, and a standard project run clips on the delineated watershed either way, through the mask the loader fills in. Declared at DEV level for that reason: a project run neither needs it nor changes with it.

One of: "watershed" "study_area"

force_refresh

bool default = False dev source

Ignore the cache and force a fresh download from the API.

mask_path

Path | None default = None user source

Optional SHP/GPKG/GeoJSON/TIF mask to spatially filter stations or clip gridded sources.

source_unit

str | None default = None user source

Optional source unit for custom gridded .nc/.tif inputs. When omitted for NetCDF, units are inferred from variable metadata.

col_id

str default = “id” dev source

Column name for the station identifier in location files.

col_x

str default = “x” dev source

Column name for the X coordinate in location files.

col_y

str default = “y” dev source

Column name for the Y coordinate in location files.

col_crs

str default = “crs” dev source

Column name for the CRS in location files.

col_datetime

str default = “datetime” dev source

Column name for timestamps in chronicle CSVs.

col_value

str default = “value” dev source

Column name for numeric values in chronicle CSVs.

default_crs

str default = “EPSG:4326” dev source

Default CRS used when a location file omits the CRS column.

source

str required user source

Data provider: ‘custom’ for user CSV files, ‘sim2’ for SIM2 EDR API.

One of: "custom" "sim2"

path

Path | None default = None user source

Directory containing location file and chronicle CSVs, or a single .nc/.tif file.

Starter TOML snippet

Click to expand a copy-pasteable [data] TOML skeleton

Copy this block into your project.toml and uncomment the lines you want to set. Sub-tables ([parent.subfield]) appear in the order Pydantic expects them.

[data]
# project_crs = ...  # default = None
# types = ...  # uses factory default

[data.dem]
# sources = []  # REQUIRED

[data.geology]
# sources = ...  # factory default
# id = "field_geology"

[data.hydrography]
# sources = []  # REQUIRED

[data.hydrometry]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

[data.intermittency]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = 0  # REQUIRED

[data.lake_abacus]
# sources = []  # REQUIRED
# id = "lake_abacus"

[data.lake_bathymetry]
# sources = []  # REQUIRED
# id = "lake_bathymetry"

[data.lake_geometry]
# sources = []  # REQUIRED
# id = "lake_geometry"

[data.lake_inflow]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

[data.lake_levels]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

[data.lake_outflow]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

[data.lake_withdrawal]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

[data.oceanic]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

[data.piezometry]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

[data.water_quality]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

[data.recharge]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

[data.runoff]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

[data.precipitation]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

[data.etp]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

[data.temperature]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

[data.wind]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

[data.humidity]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

[data.radiation]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

[data.soil_moisture]
# date_start = ...  # default = None
# date_end = ...  # default = None
# sources = []  # REQUIRED

Cases using this section

Validation gallery cases that reference fields from this section:

• Boussinesq Circular-Island Piecewise-K 2D

• Boussinesq Divide-Fixed-Head Piecewise-K 1D

• Boussinesq Sloping-Substratum Uniform-Recharge 1D

• Boussinesq Uniform-Recharge Piecewise-K 1D

• Brutsaert Recession Validation: Thin Nonlinear Aquifer

• Brutsaert Recession Validation: Deep Linearized Aquifer

• Dupuit Circular-Island Ocean 2D

• Dupuit Divide-River 1D

• Dupuit Uniform Recharge 1D

• Linearized Unconfined 1D Periodic Recharge

• Linearized Unconfined 1D Recharge Step

• Linearized Unconfined 1D Recharge Step (Deep Aquifer)

Entity-relationship diagram

Click to zoom and pan. Press Esc or click outside to close.