Configuration index#

Flat list of every TOML path validated by HydroModPyConfig. Use Ctrl+F to jump to a specific path. Each row links back to the per-section page (anchor) and to the source declaration on GitHub.

TOML path

Type

Profile

Stability

Page

Source

workflow.mode

Literal['simulation', 'calibration', 'overview', 'comparison', 'testbed', 'site_selection']

user

workflow

link

workspace.project_root

Path | UPath

user

workspace

link

workspace.root

Path | UPath | None

user

workspace

link

workspace.catalog_path

Path | None

dev

workspace

link

workspace.data_dir

Path | None

dev

workspace

link

workspace.simulations_dir

Path | None

dev

workspace

link

workspace.output_root

Path | None

user

workspace

link

geographic.source_mode

Literal['standard', 'synthetic']

user

geographic

link

geographic.catchment

Optional[DemCatchDef | TxtCatchDef | OutletCatchDef | PolygonCatchDef]

user

geographic

link

geographic.catchment.dem.dem_init_path

Path | None

user

geographic

link

geographic.catchment.dem.catch_def

Literal['dem']

user

geographic

link

geographic.catchment.txt.dem_init_path

Path | None

user

geographic

link

geographic.catchment.txt.catch_def

Literal['txt']

user

geographic

link

geographic.catchment.txt.cell_size

float

user

geographic

link

geographic.catchment.from_outlet_coord.dem_init_path

Path | None

user

geographic

link

geographic.catchment.from_outlet_coord.catch_def

Literal['from_outlet_coord']

user

geographic

link

geographic.catchment.from_outlet_coord.x_outlet

float

user

geographic

link

geographic.catchment.from_outlet_coord.y_outlet

float

user

geographic

link

geographic.catchment.from_outlet_coord.snap_dist

float

user

geographic

link

geographic.catchment.from_outlet_coord.buff_area

str | float

user

geographic

link

geographic.catchment.from_polyg_shp.dem_init_path

Path | None

user

geographic

link

geographic.catchment.from_polyg_shp.catch_def

Literal['from_polyg_shp']

user

geographic

link

geographic.catchment.from_polyg_shp.polyg_shp_path

Path

user

geographic

link

geographic.catchment.from_polyg_shp.buff_area

str | float

user

geographic

link

geographic.crs_project

str | None

user

geographic

link

geographic.dem_correc_type

Literal['breach', 'fill']

user

geographic

link

geographic.bottom_path

Path | None

user

geographic

link

geographic.reg_fold

Path | None

dev

geographic

link

geographic.synthetic

SyntheticGeographicConfig

user

geographic

link

geographic.synthetic.case_id

str

user

geographic

link

geographic.synthetic.grid

SyntheticGridConfig

user

geographic

link

geographic.synthetic.grid.length_x

float

user

geographic

link

geographic.synthetic.grid.length_y

float

user

geographic

link

geographic.synthetic.grid.nx

int

user

geographic

link

geographic.synthetic.grid.ny

int

user

geographic

link

geographic.synthetic.grid.xmin

float

dev

geographic

link

geographic.synthetic.grid.ymin

float

dev

geographic

link

geographic.synthetic.grid.crs

str

dev

geographic

link

geographic.synthetic.grid.nodata

float

dev

geographic

link

geographic.synthetic.topography

FlatTopography | LinearTopography | RadialIslandTopography

user

geographic

link

geographic.synthetic.topography.flat.kind

Literal['flat']

user

geographic

link

geographic.synthetic.topography.flat.base_elevation

float

user

geographic

link

geographic.synthetic.topography.linear.kind

Literal['linear']

user

geographic

link

geographic.synthetic.topography.linear.base_elevation

float

user

geographic

link

geographic.synthetic.topography.linear.right_to_left_amplitude

float

dev

geographic

link

geographic.synthetic.topography.radial_island.kind

Literal['radial_island']

user

geographic

link

geographic.synthetic.topography.radial_island.base_elevation

float

user

geographic

link

geographic.synthetic.topography.radial_island.island_radius

Optional[float]

dev

geographic

link

geographic.synthetic.topography.radial_island.crest_elevation

float

dev

geographic

link

geographic.synthetic.topography.radial_island.center_x

Optional[float]

dev

geographic

link

geographic.synthetic.topography.radial_island.center_y

Optional[float]

dev

geographic

link

geographic.river_network

RiverNetworkConfig

user

geographic

link

geographic.river_network.enabled

bool

user

geographic

link

geographic.river_network.threshold_mode

Literal['area_km2', 'cells']

user

geographic

link

geographic.river_network.threshold_area_km2

float | None

user

geographic

link

geographic.river_network.threshold_cells

float | None

user

geographic

link

geographic.river_network.prune_short_streams

bool

user

geographic

link

geographic.river_network.min_stream_length_m

float

user

geographic

link

geographic.river_network.compute_strahler_order

bool

user

geographic

link

geographic.river_network.compute_stream_links

bool

user

geographic

link

geographic.river_network.all_vertices

bool

user

geographic

link

geographic.reuse_existing_outputs

bool

user

geographic

link

geographic.write_intermediates

bool

dev

geographic

link

domain.zone_ids

list[str]

user

domain

link

domain.supports

dict[str, GeneratedBandsSupportConfig | GeneratedRingsSupportConfig | CatchmentZonesSupportConfig | GeologySupportConfig]

user

domain

link

domain.supports.<id>.kind

Literal['generated_bands']

user

domain

link

domain.supports.<id>.axis

Literal['x', 'y']

user

domain

link

domain.supports.<id>.coordinate_mode

Literal['relative', 'absolute']

dev

domain

link

domain.supports.<id>.breaks

list[float | str]

user

domain

link

domain.supports.<id>.labels

list[str]

user

domain

link

domain.supports.<id>.default_cell_samples_per_axis

int

dev

domain

link

domain.supports.<id>.kind

Literal['generated_rings']

user

domain

link

domain.supports.<id>.coordinate_mode

Literal['relative', 'absolute']

dev

domain

link

domain.supports.<id>.radii

list[float | str]

user

domain

link

domain.supports.<id>.labels

list[str]

user

domain

link

domain.supports.<id>.center_x

Optional[float]

dev

domain

link

domain.supports.<id>.center_y

Optional[float]

dev

domain

link

domain.supports.<id>.default_cell_samples_per_axis

int

dev

domain

link

domain.supports.<id>.kind

Literal['catchment_zones']

user

domain

link

domain.supports.<id>.source_zone_id

str

user

domain

link

domain.supports.<id>.default_cell_samples_per_axis

int

dev

domain

link

domain.supports.<id>.kind

Literal['geology']

user

domain

link

domain.depth_model

ConstantThicknessDepthModel | FlatSubstratumDepthModel

user

domain

link

domain.depth_model.constant_thickness.kind

Literal['constant_thickness']

user

domain

link

domain.depth_model.constant_thickness.thickness

float

user

domain

link

domain.depth_model.flat_substratum.kind

Literal['flat_substratum']

user

domain

link

domain.depth_model.flat_substratum.substratum_elevation

float

user

domain

link

data.project_crs

str | None

user

data

link

data.types

list[str]

user

data

link

data.inference_mode

Literal['warn', 'strict']

dev

data

link

data.dem

DemConfig | None

user

data

link

data.dem.sources

list[CustomDemSource | IgnGeoplateformeDemSource]

user

data

link

data.dem.sources.custom.mask_path

Path | None

user

data

link

data.dem.sources.custom.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.dem.sources.custom.force_refresh

bool

dev

data

link

data.dem.sources.custom.source

Literal['custom']

user

data

link

data.dem.sources.custom.path

Path

user

data

link

data.dem.sources.ign_geoplateforme_dem.mask_path

Path | None

user

data

link

data.dem.sources.ign_geoplateforme_dem.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.dem.sources.ign_geoplateforme_dem.force_refresh

bool

dev

data

link

data.dem.sources.ign_geoplateforme_dem.departments

list[str]

user

data

link

data.dem.sources.ign_geoplateforme_dem.country

str

user

data

link

data.dem.sources.ign_geoplateforme_dem.regions

list[str]

user

data

link

data.dem.sources.ign_geoplateforme_dem.source

Literal['ign_geoplateforme_dem']

user

data

link

data.dem.sources.ign_geoplateforme_dem.dataset

Literal['bd-alti']

user

data

link

data.dem.sources.ign_geoplateforme_dem.resolution_m

float | None

user

data

link

data.dem.sources.ign_geoplateforme_dem.file_format

str

user

data

link

data.dem.sources.ign_geoplateforme_dem.crs

str | None

user

data

link

data.geology

GeologyConfig | None

user

data

link

data.geology.sources

list[CustomGeologySource | BrgmGeology1mSource | BrgmGeology50kSource]

user

data

link

data.geology.sources.custom.mask_path

Path | None

user

data

link

data.geology.sources.custom.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.geology.sources.custom.force_refresh

bool

dev

data

link

data.geology.sources.custom.source

Literal['custom']

user

data

link

data.geology.sources.custom.path

Path

user

data

link

data.geology.sources.custom.code_field

str | None

user

data

link

data.geology.sources.custom.values_table_path

Path | None

user

data

link

data.geology.sources.custom.col_x

str

dev

data

link

data.geology.sources.custom.col_y

str

dev

data

link

data.geology.sources.custom.col_code

str

dev

data

link

data.geology.sources.custom.default_crs

str

dev

data

link

data.geology.sources.brgm_1m.mask_path

Path | None

user

data

link

data.geology.sources.brgm_1m.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.geology.sources.brgm_1m.force_refresh

bool

dev

data

link

data.geology.sources.brgm_1m.source

Literal['brgm_1m']

user

data

link

data.geology.sources.brgm_50k.mask_path

Path | None

user

data

link

data.geology.sources.brgm_50k.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.geology.sources.brgm_50k.force_refresh

bool

dev

data

link

data.geology.sources.brgm_50k.source

Literal['brgm_50k']

user

data

link

data.geology.id

str

user

data

link

data.geology.cell_samples_per_axis

int

dev

data

link

data.hydrography

HydrographyConfig | None

user

data

link

data.hydrography.sources

list[HydrographySourceConfig]

user

data

link

data.hydrography.sources.source

Literal['custom', 'osm', 'bdtopage', 'euhydro']

user

data

link

data.hydrography.sources.path

Path | None

user

data

link

data.hydrography.sources.rasterize_field

str

user

data

link

data.hydrography.sources.typename

str

dev

data

link

data.hydrography.sources.page_size

int

dev

data

link

data.hydrography.sources.group_name

str

dev

data

link

data.hydrography.sources.euhydro_page_size

int

dev

data

link

data.hydrography.sources.force_refresh

bool

dev

data

link

data.hydrography.sources.waterway_types

list[str]

dev

data

link

data.hydrometry

HydrometryConfig | None

user

data

link

data.hydrometry.date_start

str | None

user

data

link

data.hydrometry.date_end

str | None

user

data

link

data.hydrometry.sources

list[HydrometrySourceConfig]

user

data

link

data.hydrometry.sources.fallback_search_radius_km

float | None

dev

data

link

data.hydrometry.sources.station_ids

list[str] | None

user

data

link

data.hydrometry.sources.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.hydrometry.sources.force_refresh

bool

dev

data

link

data.hydrometry.sources.mask_path

Path | None

user

data

link

data.hydrometry.sources.source_unit

str | None

user

data

link

data.hydrometry.sources.col_id

str

dev

data

link

data.hydrometry.sources.col_x

str

dev

data

link

data.hydrometry.sources.col_y

str

dev

data

link

data.hydrometry.sources.col_crs

str

dev

data

link

data.hydrometry.sources.col_datetime

str

dev

data

link

data.hydrometry.sources.col_value

str

dev

data

link

data.hydrometry.sources.default_crs

str

dev

data

link

data.hydrometry.sources.source

Literal['custom', 'hubeau']

user

data

link

data.hydrometry.sources.path

Path | None

user

data

link

data.hydrometry.sources.product

str | None

user

data

link

data.hydrometry.sources.require_observations

bool

dev

data

link

data.hydrometry.sources.max_stations

int | None

user

data

link

data.intermittency

IntermittencyConfig | None

user

data

link

data.intermittency.date_start

str | None

user

data

link

data.intermittency.date_end

str | None

user

data

link

data.intermittency.sources

list[IntermittencySourceConfig]

user

data

link

data.intermittency.sources.fallback_search_radius_km

float | None

dev

data

link

data.intermittency.sources.station_ids

list[str] | None

user

data

link

data.intermittency.sources.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.intermittency.sources.force_refresh

bool

dev

data

link

data.intermittency.sources.mask_path

Path | None

user

data

link

data.intermittency.sources.source_unit

str | None

user

data

link

data.intermittency.sources.col_id

str

dev

data

link

data.intermittency.sources.col_x

str

dev

data

link

data.intermittency.sources.col_y

str

dev

data

link

data.intermittency.sources.col_crs

str

dev

data

link

data.intermittency.sources.col_datetime

str

dev

data

link

data.intermittency.sources.col_value

str

dev

data

link

data.intermittency.sources.default_crs

str

dev

data

link

data.intermittency.sources.source

Literal['custom', 'hubeau']

user

data

link

data.intermittency.sources.path

Path | None

user

data

link

data.intermittency.sources.code_departement

list[str] | None

user

data

link

data.intermittency.sources.require_observations

bool

dev

data

link

data.oceanic

OceanicConfig | None

user

data

link

data.oceanic.date_start

str | None

user

data

link

data.oceanic.date_end

str | None

user

data

link

data.oceanic.sources

list[OceanicSourceConfig]

user

data

link

data.oceanic.sources.fallback_search_radius_km

float | None

dev

data

link

data.oceanic.sources.station_ids

list[str] | None

user

data

link

data.oceanic.sources.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.oceanic.sources.force_refresh

bool

dev

data

link

data.oceanic.sources.mask_path

Path | None

user

data

link

data.oceanic.sources.source_unit

str | None

user

data

link

data.oceanic.sources.col_id

str

dev

data

link

data.oceanic.sources.col_x

str

dev

data

link

data.oceanic.sources.col_y

str

dev

data

link

data.oceanic.sources.col_crs

str

dev

data

link

data.oceanic.sources.col_datetime

str

dev

data

link

data.oceanic.sources.col_value

str

dev

data

link

data.oceanic.sources.default_crs

str

dev

data

link

data.oceanic.sources.source

Literal['custom', 'shom', 'constant']

user

data

link

data.oceanic.sources.path

Path | None

user

data

link

data.oceanic.sources.value

float | None

user

data

link

data.oceanic.sources.nearest

bool

dev

data

link

data.oceanic.sources.require_observations

bool

dev

data

link

data.piezometry

PiezometryConfig | None

user

data

link

data.piezometry.date_start

str | None

user

data

link

data.piezometry.date_end

str | None

user

data

link

data.piezometry.sources

list[PiezometrySourceConfig]

user

data

link

data.piezometry.sources.fallback_search_radius_km

float | None

dev

data

link

data.piezometry.sources.station_ids

list[str] | None

user

data

link

data.piezometry.sources.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.piezometry.sources.force_refresh

bool

dev

data

link

data.piezometry.sources.mask_path

Path | None

user

data

link

data.piezometry.sources.source_unit

str | None

user

data

link

data.piezometry.sources.col_id

str

dev

data

link

data.piezometry.sources.col_x

str

dev

data

link

data.piezometry.sources.col_y

str

dev

data

link

data.piezometry.sources.col_crs

str

dev

data

link

data.piezometry.sources.col_datetime

str

dev

data

link

data.piezometry.sources.col_value

str

dev

data

link

data.piezometry.sources.default_crs

str

dev

data

link

data.piezometry.sources.source

Literal['custom', 'hubeau']

user

data

link

data.piezometry.sources.path

Path | None

user

data

link

data.piezometry.sources.product

Optional[Literal['level', 'depth']]

user

data

link

data.piezometry.sources.require_observations

bool

dev

data

link

data.piezometry.sources.nearest

bool

dev

data

link

data.water_quality

WaterQualityConfig | None

user

data

link

data.water_quality.date_start

str | None

user

data

link

data.water_quality.date_end

str | None

user

data

link

data.water_quality.sources

list[WaterQualitySourceConfig]

user

data

link

data.water_quality.sources.fallback_search_radius_km

float | None

dev

data

link

data.water_quality.sources.station_ids

list[str] | None

user

data

link

data.water_quality.sources.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.water_quality.sources.force_refresh

bool

dev

data

link

data.water_quality.sources.mask_path

Path | None

user

data

link

data.water_quality.sources.source_unit

str | None

user

data

link

data.water_quality.sources.col_id

str

dev

data

link

data.water_quality.sources.col_x

str

dev

data

link

data.water_quality.sources.col_y

str

dev

data

link

data.water_quality.sources.col_crs

str

dev

data

link

data.water_quality.sources.col_datetime

str

dev

data

link

data.water_quality.sources.col_value

str

dev

data

link

data.water_quality.sources.default_crs

str

dev

data

link

data.water_quality.sources.source

Literal['custom', 'hubeau']

user

data

link

data.water_quality.sources.site_type

Literal['river', 'piezometer']

user

data

link

data.water_quality.sources.parameters

list[str] | None

user

data

link

data.water_quality.sources.path

Path | None

user

data

link

data.water_quality.sources.nearest

bool

dev

data

link

data.recharge

RechargeConfig | None

user

data

link

data.recharge.date_start

str | None

user

data

link

data.recharge.date_end

str | None

user

data

link

data.recharge.sources

list[RechargeSourceConfig]

user

data

link

data.recharge.sources.station_ids

list[str] | None

user

data

link

data.recharge.sources.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.recharge.sources.force_refresh

bool

dev

data

link

data.recharge.sources.mask_path

Path | None

user

data

link

data.recharge.sources.source_unit

str | None

user

data

link

data.recharge.sources.col_id

str

dev

data

link

data.recharge.sources.col_x

str

dev

data

link

data.recharge.sources.col_y

str

dev

data

link

data.recharge.sources.col_crs

str

dev

data

link

data.recharge.sources.col_datetime

str

dev

data

link

data.recharge.sources.col_value

str

dev

data

link

data.recharge.sources.default_crs

str

dev

data

link

data.recharge.sources.source

Literal['custom', 'sim2', 'synthetic']

user

data

link

data.recharge.sources.path

Path | None

user

data

link

data.recharge.sources.values

list[float] | None

user

data

link

data.recharge.sources.start_date

str | None

user

data

link

data.recharge.sources.freq

str | None

dev

data

link

data.recharge.sources.periods

int | None

dev

data

link

data.recharge.sources.amplitude

float | None

expert

data

link

data.recharge.sources.period_days

int | None

expert

data

link

data.recharge.sources.offset

float | None

expert

data

link

data.recharge.sources.runoff_ratio

float | None

dev

data

link

data.runoff

RunoffConfig | None

user

data

link

data.runoff.date_start

str | None

user

data

link

data.runoff.date_end

str | None

user

data

link

data.runoff.sources

list[RunoffSourceConfig]

user

data

link

data.runoff.sources.station_ids

list[str] | None

user

data

link

data.runoff.sources.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.runoff.sources.force_refresh

bool

dev

data

link

data.runoff.sources.mask_path

Path | None

user

data

link

data.runoff.sources.source_unit

str | None

user

data

link

data.runoff.sources.col_id

str

dev

data

link

data.runoff.sources.col_x

str

dev

data

link

data.runoff.sources.col_y

str

dev

data

link

data.runoff.sources.col_crs

str

dev

data

link

data.runoff.sources.col_datetime

str

dev

data

link

data.runoff.sources.col_value

str

dev

data

link

data.runoff.sources.default_crs

str

dev

data

link

data.runoff.sources.source

Literal['custom', 'sim2']

user

data

link

data.runoff.sources.path

Path | None

user

data

link

data.precipitation

PrecipitationConfig | None

user

data

link

data.precipitation.date_start

str | None

user

data

link

data.precipitation.date_end

str | None

user

data

link

data.precipitation.sources

list[PrecipitationSourceConfig]

user

data

link

data.precipitation.sources.station_ids

list[str] | None

user

data

link

data.precipitation.sources.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.precipitation.sources.force_refresh

bool

dev

data

link

data.precipitation.sources.mask_path

Path | None

user

data

link

data.precipitation.sources.source_unit

str | None

user

data

link

data.precipitation.sources.col_id

str

dev

data

link

data.precipitation.sources.col_x

str

dev

data

link

data.precipitation.sources.col_y

str

dev

data

link

data.precipitation.sources.col_crs

str

dev

data

link

data.precipitation.sources.col_datetime

str

dev

data

link

data.precipitation.sources.col_value

str

dev

data

link

data.precipitation.sources.default_crs

str

dev

data

link

data.precipitation.sources.source

Literal['custom', 'sim2']

user

data

link

data.precipitation.sources.components

list[Literal['liquid', 'solid', 'total']]

user

data

link

data.precipitation.sources.path

Path | None

user

data

link

data.etp

EtpConfig | None

user

data

link

data.etp.date_start

str | None

user

data

link

data.etp.date_end

str | None

user

data

link

data.etp.sources

list[EtpSourceConfig]

user

data

link

data.etp.sources.station_ids

list[str] | None

user

data

link

data.etp.sources.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.etp.sources.force_refresh

bool

dev

data

link

data.etp.sources.mask_path

Path | None

user

data

link

data.etp.sources.source_unit

str | None

user

data

link

data.etp.sources.col_id

str

dev

data

link

data.etp.sources.col_x

str

dev

data

link

data.etp.sources.col_y

str

dev

data

link

data.etp.sources.col_crs

str

dev

data

link

data.etp.sources.col_datetime

str

dev

data

link

data.etp.sources.col_value

str

dev

data

link

data.etp.sources.default_crs

str

dev

data

link

data.etp.sources.source

Literal['custom', 'sim2']

user

data

link

data.etp.sources.path

Path | None

user

data

link

data.etp.sources.crs

str | None

user

data

link

data.etp.sources.nodata

float | int | str | None

user

data

link

data.temperature

TemperatureConfig | None

user

data

link

data.temperature.date_start

str | None

user

data

link

data.temperature.date_end

str | None

user

data

link

data.temperature.sources

list[TemperatureSourceConfig]

user

data

link

data.temperature.sources.station_ids

list[str] | None

user

data

link

data.temperature.sources.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.temperature.sources.force_refresh

bool

dev

data

link

data.temperature.sources.mask_path

Path | None

user

data

link

data.temperature.sources.source_unit

str | None

user

data

link

data.temperature.sources.col_id

str

dev

data

link

data.temperature.sources.col_x

str

dev

data

link

data.temperature.sources.col_y

str

dev

data

link

data.temperature.sources.col_crs

str

dev

data

link

data.temperature.sources.col_datetime

str

dev

data

link

data.temperature.sources.col_value

str

dev

data

link

data.temperature.sources.default_crs

str

dev

data

link

data.temperature.sources.source

Literal['custom', 'sim2']

user

data

link

data.temperature.sources.path

Path | None

user

data

link

data.wind

WindConfig | None

user

data

link

data.wind.date_start

str | None

user

data

link

data.wind.date_end

str | None

user

data

link

data.wind.sources

list[WindSourceConfig]

user

data

link

data.wind.sources.station_ids

list[str] | None

user

data

link

data.wind.sources.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.wind.sources.force_refresh

bool

dev

data

link

data.wind.sources.mask_path

Path | None

user

data

link

data.wind.sources.source_unit

str | None

user

data

link

data.wind.sources.col_id

str

dev

data

link

data.wind.sources.col_x

str

dev

data

link

data.wind.sources.col_y

str

dev

data

link

data.wind.sources.col_crs

str

dev

data

link

data.wind.sources.col_datetime

str

dev

data

link

data.wind.sources.col_value

str

dev

data

link

data.wind.sources.default_crs

str

dev

data

link

data.wind.sources.source

Literal['custom', 'sim2']

user

data

link

data.wind.sources.path

Path | None

user

data

link

data.humidity

HumidityConfig | None

user

data

link

data.humidity.date_start

str | None

user

data

link

data.humidity.date_end

str | None

user

data

link

data.humidity.sources

list[HumiditySourceConfig]

user

data

link

data.humidity.sources.station_ids

list[str] | None

user

data

link

data.humidity.sources.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.humidity.sources.force_refresh

bool

dev

data

link

data.humidity.sources.mask_path

Path | None

user

data

link

data.humidity.sources.source_unit

str | None

user

data

link

data.humidity.sources.col_id

str

dev

data

link

data.humidity.sources.col_x

str

dev

data

link

data.humidity.sources.col_y

str

dev

data

link

data.humidity.sources.col_crs

str

dev

data

link

data.humidity.sources.col_datetime

str

dev

data

link

data.humidity.sources.col_value

str

dev

data

link

data.humidity.sources.default_crs

str

dev

data

link

data.humidity.sources.source

Literal['custom', 'sim2']

user

data

link

data.humidity.sources.path

Path | None

user

data

link

data.radiation

RadiationConfig | None

user

data

link

data.radiation.date_start

str | None

user

data

link

data.radiation.date_end

str | None

user

data

link

data.radiation.sources

list[RadiationSourceConfig]

user

data

link

data.radiation.sources.station_ids

list[str] | None

user

data

link

data.radiation.sources.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.radiation.sources.force_refresh

bool

dev

data

link

data.radiation.sources.mask_path

Path | None

user

data

link

data.radiation.sources.source_unit

str | None

user

data

link

data.radiation.sources.col_id

str

dev

data

link

data.radiation.sources.col_x

str

dev

data

link

data.radiation.sources.col_y

str

dev

data

link

data.radiation.sources.col_crs

str

dev

data

link

data.radiation.sources.col_datetime

str

dev

data

link

data.radiation.sources.col_value

str

dev

data

link

data.radiation.sources.default_crs

str

dev

data

link

data.radiation.sources.source

Literal['custom', 'sim2']

user

data

link

data.radiation.sources.components

list[Literal['atmospheric', 'visible']]

user

data

link

data.radiation.sources.path

Path | None

user

data

link

data.soil_moisture

SoilMoistureConfig | None

user

data

link

data.soil_moisture.date_start

str | None

user

data

link

data.soil_moisture.date_end

str | None

user

data

link

data.soil_moisture.sources

list[SoilMoistureSourceConfig]

user

data

link

data.soil_moisture.sources.station_ids

list[str] | None

user

data

link

data.soil_moisture.sources.extent

Optional[Literal['watershed', 'study_area']]

user

data

link

data.soil_moisture.sources.force_refresh

bool

dev

data

link

data.soil_moisture.sources.mask_path

Path | None

user

data

link

data.soil_moisture.sources.source_unit

str | None

user

data

link

data.soil_moisture.sources.col_id

str

dev

data

link

data.soil_moisture.sources.col_x

str

dev

data

link

data.soil_moisture.sources.col_y

str

dev

data

link

data.soil_moisture.sources.col_crs

str

dev

data

link

data.soil_moisture.sources.col_datetime

str

dev

data

link

data.soil_moisture.sources.col_value

str

dev

data

link

data.soil_moisture.sources.default_crs

str

dev

data

link

data.soil_moisture.sources.source

Literal['custom', 'sim2']

user

data

link

data.soil_moisture.sources.path

Path | None

user

data

link

flow.runtime_backend

Literal['local', 'scipy', 'scipy_sparse', 'petsc']

dev

experimental

flow

link

flow.surface_interaction_model

Literal['auto', 'regularized_partition', 'complementarity', 'vi_obstacle', 'ts_vi_obstacle']

dev

experimental

flow

link

flow.runtime_max_iterations

int | None

dev

flow

link

flow.runtime_tol_residual_inf

float | None

dev

flow

link

flow.runtime_tol_state_update_inf

float | None

dev

flow

link

flow.vi_substeps_per_period

int

dev

flow

link

flow.vi_substep_on_failure

bool

dev

flow

link

flow.vi_max_adaptive_substeps

int | None

dev

flow

link

flow.ts_vi_steps_per_period

int

dev

flow

link

flow.ts_vi_adapt

bool

dev

flow

link

flow.ts_vi_dt_min_fraction

float

dev

flow

link

flow.ts_vi_dt_max_fraction

float

dev

flow

link

flow.ts_vi_type

str

dev

flow

link

flow.ts_vi_snes_type

str

dev

flow

link

flow.param_list

list[str]

user

flow

link

flow.param

dict[str, FlowParam]

user

flow

link

flow.param.<id>.field

FieldHomogeneousSection | FieldHeterogeneousSection

user

flow

link

flow.param.<id>.field.homogeneous.id

Optional[str]

user

flow

link

flow.param.<id>.field.homogeneous.kind

Literal['homogeneous']

user

flow

link

flow.param.<id>.field.homogeneous.unit

str | None

user

flow

link

flow.param.<id>.field.homogeneous.value

object | None

user

flow

link

flow.param.<id>.field.heterogeneous.id

Optional[str]

user

flow

link

flow.param.<id>.field.heterogeneous.kind

Literal['heterogeneous']

user

flow

link

flow.param.<id>.field.heterogeneous.unit

str | None

user

flow

link

flow.param.<id>.field.heterogeneous.values_source

Literal['inline', 'csv']

user

flow

link

flow.param.<id>.field.heterogeneous.values

dict[str, float | str] | None

user

flow

link

flow.param.<id>.field.heterogeneous.values_csv_file

Optional[str]

dev

flow

link

flow.param.<id>.field.heterogeneous.csv_key_column

str

dev

flow

link

flow.param.<id>.field.heterogeneous.csv_value_column

str

dev

flow

link

flow.param.<id>.field.heterogeneous.field_spatial_id

Optional[str]

user

flow

link

flow.param.<id>.field_vertical_profile

FieldVerticalProfileSection | None

user

flow

link

flow.param.<id>.field_vertical_profile.mode

Literal['none', 'exponential', 'tabulated']

user

flow

link

flow.param.<id>.field_vertical_profile.characteristic_depth

Optional[Any]

dev

flow

link

flow.param.<id>.field_vertical_profile.min_factor

Optional[float]

dev

flow

link

flow.param.<id>.field_vertical_profile.depths

list[float] | None

dev

flow

link

flow.param.<id>.field_vertical_profile.factors

list[float] | None

dev

flow

link

flow.param.<id>.field_vertical_profile.interpolation

Literal['linear', 'step']

dev

flow

link

flow.ic

FlowInitialConditions

user

flow

link

flow.ic.h

FlowICTop | FlowICTopOffset | FlowICBottom | FlowICCustom | FlowICSteadyState

user

flow

link

flow.ic.h.top.id

str

dev

flow

link

flow.ic.h.top.value

object | None

user

flow

link

flow.ic.h.top.description

str

user

flow

link

flow.ic.h.top.units

str

dev

flow

link

flow.ic.h.top.type

Literal['top']

user

flow

link

flow.ic.h.top_offset.id

str

dev

flow

link

flow.ic.h.top_offset.value

Any

user

flow

link

flow.ic.h.top_offset.description

str

user

flow

link

flow.ic.h.top_offset.units

str

user

flow

link

flow.ic.h.top_offset.type

Literal['top_offset']

user

flow

link

flow.ic.h.bottom.id

str

dev

flow

link

flow.ic.h.bottom.value

object | None

user

flow

link

flow.ic.h.bottom.description

str

user

flow

link

flow.ic.h.bottom.units

str

dev

flow

link

flow.ic.h.bottom.type

Literal['bottom']

user

flow

link

flow.ic.h.custom.id

str

dev

flow

link

flow.ic.h.custom.value

Any

user

flow

link

flow.ic.h.custom.description

str

user

flow

link

flow.ic.h.custom.units

str

user

flow

link

flow.ic.h.custom.type

Literal['custom']

user

flow

link

flow.ic.h.steady_state.id

str

dev

flow

link

flow.ic.h.steady_state.value

object | None

user

flow

link

flow.ic.h.steady_state.description

str

user

flow

link

flow.ic.h.steady_state.units

str

dev

flow

link

flow.ic.h.steady_state.type

Literal['steady_state']

user

flow

link

flow.ic.h.steady_state.source

Optional[Literal['recharge', 'mean_recharge']]

user

flow

link

flow.ic.h.steady_state.recharge_statistic

Optional[Literal['time_mean']]

user

flow

link

flow.ic.h.steady_state.boundary_condition_policy

Optional[Literal['first_period']]

user

flow

link

flow.bc

dict[str, DirichletBC | CauchyBC | RobinBC]

user

flow

link

flow.bc.dirichlet.<id>.id

str

user

flow

link

flow.bc.dirichlet.<id>.value

float | list[float] | None

user

flow

link

flow.bc.dirichlet.<id>.description

str

user

flow

link

flow.bc.dirichlet.<id>.units

str

dev

flow

link

flow.bc.dirichlet.<id>.kind

Literal['dirichlet']

user

flow

link

flow.bc.dirichlet.<id>.data_value

bool

dev

flow

link

flow.bc.dirichlet.<id>.forcing

Optional[FlowBoundaryForcingConstantConfig | FlowBoundaryForcingCsvConfig]

dev

flow

link

flow.bc.dirichlet.<id>.forcing.constant.mode

Literal['constant']

user

flow

link

flow.bc.dirichlet.<id>.forcing.constant.value

float

user

flow

link

flow.bc.dirichlet.<id>.forcing.constant.units

str | None

dev

flow

link

flow.bc.dirichlet.<id>.forcing.csv.mode

Literal['csv']

user

flow

link

flow.bc.dirichlet.<id>.forcing.csv.path_file

Path

dev

flow

link

flow.bc.dirichlet.<id>.forcing.csv.sep

str

dev

flow

link

flow.bc.dirichlet.<id>.forcing.csv.date_column

str

dev

flow

link

flow.bc.dirichlet.<id>.forcing.csv.date_format

str | None

dev

flow

link

flow.bc.dirichlet.<id>.forcing.csv.value_column

str

dev

flow

link

flow.bc.dirichlet.<id>.forcing.csv.fill_method

Literal['ffill', 'bfill']

dev

flow

link

flow.bc.dirichlet.<id>.forcing.csv.aggregate

Literal['mean', 'last']

dev

flow

link

flow.bc.dirichlet.<id>.forcing.csv.units

str | None

dev

flow

link

flow.bc.dirichlet.<id>.application_domain

str | None

user

flow

link

flow.bc.dirichlet.<id>.support_label

Optional[str]

user

flow

link

flow.bc.cauchy.<id>.id

str

user

flow

link

flow.bc.cauchy.<id>.value

float | list[float] | None

user

flow

link

flow.bc.cauchy.<id>.description

str

user

flow

link

flow.bc.cauchy.<id>.units

str

dev

flow

link

flow.bc.cauchy.<id>.kind

Literal['cauchy']

user

flow

link

flow.bc.cauchy.<id>.data_value

bool

dev

flow

link

flow.bc.cauchy.<id>.application_domain

str | None

user

flow

link

flow.bc.cauchy.<id>.support_label

Optional[str]

user

flow

link

flow.bc.robin.<id>.id

str

user

flow

link

flow.bc.robin.<id>.value

float | list[float] | None

user

flow

link

flow.bc.robin.<id>.description

str

user

flow

link

flow.bc.robin.<id>.units

str

dev

flow

link

flow.bc.robin.<id>.kind

Literal['robin']

user

flow

link

flow.bc.robin.<id>.data_value

bool

dev

flow

link

flow.bc.robin.<id>.application_domain

str | None

user

flow

link

flow.bc.robin.<id>.support_label

Optional[str]

user

flow

link

flow.sinks_sources

FlowSinksSourcesConfig

user

flow

link

flow.sinks_sources.wells

dict[str, FlowWellConfig]

user

flow

link

flow.sinks_sources.wells.<id>.location

FlowWellLocationCell | FlowWellLocationAbsoluteXY | FlowWellLocationRelativeXY

user

flow

link

flow.sinks_sources.wells.<id>.location.cell.kind

Literal['cell']

user

flow

link

flow.sinks_sources.wells.<id>.location.cell.cell

tuple[int, int, int]

user

flow

link

flow.sinks_sources.wells.<id>.location.absolute_xy.kind

Literal['absolute_xy']

user

flow

link

flow.sinks_sources.wells.<id>.location.absolute_xy.layer

int

dev

flow

link

flow.sinks_sources.wells.<id>.location.absolute_xy.x

float

user

flow

link

flow.sinks_sources.wells.<id>.location.absolute_xy.y

float

user

flow

link

flow.sinks_sources.wells.<id>.location.relative_xy.kind

Literal['relative_xy']

user

flow

link

flow.sinks_sources.wells.<id>.location.relative_xy.layer

int

dev

flow

link

flow.sinks_sources.wells.<id>.location.relative_xy.x_rel

float

user

flow

link

flow.sinks_sources.wells.<id>.location.relative_xy.y_rel

float

user

flow

link

flow.sinks_sources.wells.<id>.flux

float | list[float] | None

user

flow

link

flow.sinks_sources.wells.<id>.forcing

Optional[FlowWellForcingConstantConfig | FlowWellForcingCsvConfig]

dev

flow

link

flow.sinks_sources.wells.<id>.forcing.constant.kind

Literal['constant']

user

flow

link

flow.sinks_sources.wells.<id>.forcing.constant.value

Any

user

flow

link

flow.sinks_sources.wells.<id>.forcing.constant.units

str | None

dev

flow

link

flow.sinks_sources.wells.<id>.forcing.csv.kind

Literal['csv']

user

flow

link

flow.sinks_sources.wells.<id>.forcing.csv.path_file

Path

dev

flow

link

flow.sinks_sources.wells.<id>.forcing.csv.sep

str

dev

flow

link

flow.sinks_sources.wells.<id>.forcing.csv.date_column

str

dev

flow

link

flow.sinks_sources.wells.<id>.forcing.csv.date_format

str | None

dev

flow

link

flow.sinks_sources.wells.<id>.forcing.csv.value_column

str

dev

flow

link

flow.sinks_sources.wells.<id>.forcing.csv.fill_method

Literal['ffill', 'bfill']

dev

flow

link

flow.sinks_sources.wells.<id>.forcing.csv.aggregate

Literal['mean', 'last']

dev

flow

link

flow.sinks_sources.wells.<id>.forcing.csv.units

str | None

dev

flow

link

flow.sinks_sources.wells.<id>.units

str

dev

flow

link

flow.sinks_sources.wells.<id>.description

str

user

flow

link

flow.sinks_sources.recharge

FlowRechargeConfig | None

user

flow

link

flow.sinks_sources.recharge.values

Any

user

flow

link

flow.sinks_sources.recharge.heterogeneous_source

Any

dev

flow

link

flow.sinks_sources.recharge.first_clim

str | float

dev

flow

link

flow.sinks_sources.recharge.units

str

dev

flow

link

flow.sinks_sources.recharge.negative_to_evt

bool

dev

flow

link

flow.sinks_sources.recharge.spatial_mode

Literal['auto', 'homogeneous', 'heterogeneous']

dev

flow

link

flow.sinks_sources.recharge.interpolation_method

Literal['nearest', 'linear', 'idw']

dev

flow

link

flow.sinks_sources.etp

FlowEtpConfig | None

user

flow

link

flow.sinks_sources.etp.values

Any

user

flow

link

flow.sinks_sources.etp.heterogeneous_source

Any

dev

flow

link

flow.sinks_sources.etp.first_clim

str | float

dev

flow

link

flow.sinks_sources.etp.units

str

dev

flow

link

flow.sinks_sources.etp.surface_offset

Any

dev

flow

link

flow.sinks_sources.etp.extinction_depth

Any

dev

flow

link

flow.sinks_sources.etp.spatial_mode

Literal['auto', 'homogeneous', 'heterogeneous']

dev

flow

link

flow.sinks_sources.etp.interpolation_method

Literal['nearest', 'linear', 'idw']

dev

flow

link

flow.active_sinks_sources

list[str]

user

flow

link

flow.active_bc

list[str]

user

flow

link

flow.flow_regime

Literal['steady', 'transient']

user

flow

link

flow.first_period_steady

bool

user

flow

link

transport.active_sinks_sources

list[str]

user

transport

link

transport.active_bc

list[str]

user

transport

link

transport.modpath

TransportModpathConfig

user

transport

link

transport.modpath.parameters

ModpathParametersConfig

user

transport

link

transport.modpath.parameters.zone_partic

str

dev

transport

link

transport.modpath.parameters.track_dir

Literal['forward', 'backward', 'custom']

dev

transport

link

transport.modpath.parameters.bore_depth

list[float] | None

dev

transport

link

transport.modpath.parameters.cell_div

int

dev

transport

link

transport.modpath.parameters.zloc_div

bool

dev

transport

link

transport.modpath.parameters.sel_random

int | None

dev

transport

link

transport.modpath.parameters.sel_slice

int | None

dev

transport

link

transport.mt3dms

TransportMt3dmsConfig

user

transport

link

transport.mt3dms.parameters

ConcentrationTransportParametersConfig

user

transport

link

transport.mt3dms.parameters.spc_name

str

dev

transport

link

transport.mt3dms.parameters.sconc_init

float

dev

transport

link

transport.mt3dms.parameters.sconc_input

float

dev

transport

link

transport.mt3dms.parameters.disp_long

float

dev

transport

link

transport.mt3dms.parameters.disp_transh

float

dev

transport

link

transport.mt3dms.parameters.disp_transv

float

dev

transport

link

transport.mt3dms.parameters.diffu_coeff

float

dev

transport

link

transport.mt3dms.parameters.react_order

Literal[None, 0, 1]

dev

transport

link

transport.mt3dms.parameters.scheme

Literal['upstream', 'central', 'TVD']

dev

transport

link

transport.mt3dms.parameters.rate_decay

float

dev

transport

link

transport.mt3dms.parameters.porosity

float | None

dev

transport

link

transport.mt3dms.parameters.plot_conc

bool

dev

transport

link

transport.modflow6gwt

TransportModflow6GwtConfig

user

transport

link

transport.modflow6gwt.parameters

ConcentrationTransportParametersConfig

user

transport

link

transport.modflow6gwt.parameters.spc_name

str

dev

transport

link

transport.modflow6gwt.parameters.sconc_init

float

dev

transport

link

transport.modflow6gwt.parameters.sconc_input

float

dev

transport

link

transport.modflow6gwt.parameters.disp_long

float

dev

transport

link

transport.modflow6gwt.parameters.disp_transh

float

dev

transport

link

transport.modflow6gwt.parameters.disp_transv

float

dev

transport

link

transport.modflow6gwt.parameters.diffu_coeff

float

dev

transport

link

transport.modflow6gwt.parameters.react_order

Literal[None, 0, 1]

dev

transport

link

transport.modflow6gwt.parameters.scheme

Literal['upstream', 'central', 'TVD']

dev

transport

link

transport.modflow6gwt.parameters.rate_decay

float

dev

transport

link

transport.modflow6gwt.parameters.porosity

float | None

dev

transport

link

transport.modflow6gwt.parameters.plot_conc

bool

dev

transport

link

transport.modflow6prt

TransportModflow6PrtConfig

user

transport

link

transport.modflow6prt.parameters

Modflow6PrtParametersConfig

user

transport

link

transport.modflow6prt.parameters.release_zone

str

dev

transport

link

transport.modflow6prt.parameters.upstream_top_quantile

float

dev

transport

link

transport.modflow6prt.parameters.outlet_bottom_quantile

float

dev

transport

link

transport.modflow6prt.parameters.track_dir

Literal['forward']

dev

transport

link

transport.modflow6prt.parameters.porosity

float | None

dev

transport

link

transport.modflow6prt.parameters.local_z

float

dev

transport

link

transport.modflow6prt.parameters.particle_cell_ids

list[int] | None

dev

transport

link

transport.modflow6prt.parameters.max_particles

int | None

dev

transport

link

transport.modflow6prt.parameters.sel_slice

int | None

dev

transport

link

transport.modflow6prt.parameters.release_times_days

list[float] | None

dev

transport

link

transport.modflow6prt.parameters.track_times_days

list[float] | None

dev

transport

link

transport.modflow6prt.parameters.track_time_step_days

float | None

dev

transport

link

transport.modflow6prt.parameters.stop_time_days

float | None

dev

transport

link

transport.modflow6prt.parameters.stop_travel_time_days

float | None

dev

transport

link

transport.modflow6prt.parameters.extend_tracking

bool

dev

transport

link

transport.modflow6prt.parameters.dry_tracking_method

Literal['drop', 'stop', 'stay']

dev

transport

link

transport.modflow6prt.parameters.exit_solve_tolerance

float

dev

transport

link

transport.modflow6prt.parameters.write_track_csv

bool

dev

transport

link

transport.modflow6prt.parameters.write_track_binary

bool

dev

transport

link

simulation.name

str

user

simulation

link

simulation.run_id

str

user

simulation

link

simulation.on_collision

Literal['replace', 'fail', 'version']

user

simulation

link

simulation.description

str

user

simulation

link

simulation.scientific_objective

str | None

user

simulation

link

simulation.contact_email

str | None

user

simulation

link

simulation.doi

str | None

user

simulation

link

simulation.study_area_name

str | None

user

simulation

link

simulation.outlet_x

float | None

user

simulation

link

simulation.outlet_y

float | None

user

simulation

link

simulation.time

SimulationTimeConfig | None

user

simulation

link

simulation.time.start_datetime

datetime.datetime | None

user

simulation

link

simulation.time.end_datetime

datetime.datetime | None

user

simulation

link

simulation.time.step_value

int | float | str

user

simulation

link

simulation.time.step_unit

Optional[Literal['hour', 'day', 'month', 'year']]

user

simulation

link

simulation.time.substeps_per_period

int

dev

simulation

link

simulation.time.coverage_policy

Literal['error', 'warn', 'ignore']

dev

simulation

link

simulation.process

list[FlowProcessConfig | TransportProcessConfig | MeshProcessConfig]

user

simulation

link

simulation.process.flow.id

str

user

simulation

link

simulation.process.flow.type

Literal['flow']

user

simulation

link

simulation.process.flow.solvers

list[str]

user

simulation

link

simulation.process.transport.id

str

user

simulation

link

simulation.process.transport.type

Literal['transport']

user

simulation

link

simulation.process.transport.solvers

list[str]

user

simulation

link

simulation.process.mesh.id

str

user

simulation

link

simulation.process.mesh.type

Literal['mesh']

user

simulation

link

simulation.process.mesh.backend

Literal['catchment']

user

simulation

link

simulation.process.mesh.solvers

list[str]

user

simulation

link

simulation.results

ResultsConfig

dev

simulation

link

simulation.results.persistence

PersistenceConfig

user

simulation

link

simulation.results.persistence.save_catalog

bool

user

simulation

link

simulation.results.persistence.save_zarr

bool

user

simulation

link

simulation.results.persistence.save_parquet

bool

user

simulation

link

simulation.results.persistence.save_lock

bool

user

simulation

link

simulation.results.persistence.compression

Literal['none', 'zstd', 'lz4', 'gzip', 'snappy']

dev

simulation

link

simulation.results.persistence.compression_level

int

dev

simulation

link

simulation.results.keep_solver_files

bool

dev

simulation

link

simulation.results.solver_scratch

str

dev

simulation

link

simulation.results.derived

DerivedConfig

user

simulation

link

simulation.results.derived.watertable_elevation

bool

user

simulation

link

simulation.results.derived.watertable_depth

bool

user

simulation

link

simulation.results.derived.seepage_areas

bool

user

simulation

link

simulation.results.derived.groundwater_flux

bool

dev

simulation

link

simulation.results.derived.release_flux

bool

dev

simulation

link

simulation.results.derived.accumulation_flux

bool

dev

simulation

link

simulation.results.derived.release_accumulation_flux

bool

dev

simulation

link

simulation.results.derived.outflow_drain

bool

dev

simulation

link

simulation.results.derived.concentration_seepage

bool

dev

simulation

link

simulation.results.derived.mass_seepage

bool

dev

simulation

link

simulation.results.derived.mass_accumulated

bool

dev

simulation

link

simulation.results.budget

BudgetConfig

dev

simulation

link

simulation.results.budget.spatial_fields

bool

dev

simulation

link

simulation.results.export

ExportConfig

user

simulation

link

simulation.results.export.netcdf

bool

user

simulation

link

simulation.results.export.csv_timeseries

bool

user

simulation

link

simulation.results.export.vtu

bool

dev

simulation

link

simulation.results.export.geotiff

bool

dev

simulation

link

simulation.results.export.shapefile

bool

dev

simulation

link

simulation.results.export.output_dir

str | None

dev

simulation

link

simulation.results.export.variables

ExportVariablesConfig

user

simulation

link

simulation.results.export.variables.head

bool

user

simulation

link

simulation.results.export.variables.concentration

bool

user

simulation

link

simulation.results.export.variables.budget

bool

dev

simulation

link

simulation.results.export.variables.pathlines

bool

dev

simulation

link

simulation.results.export.variables.derived

bool

user

simulation

link

simulation.results.export.resolution

float | None

dev

simulation

link

simulation.results.export.artifacts

list[ExportSpec]

dev

simulation

link

simulation.results.export.artifacts.var

str | list[str]

user

simulation

link

simulation.results.export.artifacts.dest

Path

user

simulation

link

simulation.results.export.artifacts.fmt

ExportFormat | None

user

simulation

link

simulation.results.export.artifacts.time

Union[int, list[int], Literal['first', 'last', 'all'], NoneType]

user

simulation

link

simulation.results.export.artifacts.layer

int | None

dev

simulation

link

simulation.results.export.artifacts.resolution

float | None

dev

simulation

link

simulation.results.export.artifacts.crs

str | None

dev

simulation

link

simulation.results.export.artifacts.nodata

float

dev

simulation

link

simulation.rng_seed

int | None

user

simulation

link

solver.backend

Modflow6Backend | ModflowNwtBackend | BoussinesqBackend | CustomBackend

user

solver

link

solver.backend.backend

Literal['modflow6']

user

solver

link

solver.backend.backend

Literal['modflow_nwt']

user

solver

link

solver.backend.backend

Literal['boussinesq']

user

solver

link

solver.backend.backend

Literal['custom']

user

solver

link

solver.backend.name

str

user

solver

link

modflownwt.runtime

ModflowRuntimeConfig

expert

modflownwt

link

modflownwt.runtime.nwt

NwtSolverConfig

expert

modflownwt

link

modflownwt.runtime.nwt.version

str

expert

modflownwt

link

modflownwt.runtime.nwt.listunit

int

expert

modflownwt

link

modflownwt.runtime.nwt.verbose

bool

expert

modflownwt

link

modflownwt.runtime.nwt.headtol

float

expert

modflownwt

link

modflownwt.runtime.nwt.fluxtol

float

expert

modflownwt

link

modflownwt.runtime.nwt.maxiterout

int

expert

modflownwt

link

modflownwt.runtime.nwt.thickfact

float

expert

modflownwt

link

modflownwt.runtime.nwt.linmeth

int

expert

modflownwt

link

modflownwt.runtime.nwt.iprnwt

int

expert

modflownwt

link

modflownwt.runtime.nwt.ibotav

int

expert

modflownwt

link

modflownwt.runtime.nwt.options

str

expert

modflownwt

link

modflownwt.runtime.nwt.continue_run

bool

expert

modflownwt

link

modflownwt.runtime.nwt.backflag

int

expert

modflownwt

link

modflownwt.runtime.nwt.stoptol

float

expert

modflownwt

link

modflownwt.runtime.dis

DisConfig

expert

modflownwt

link

modflownwt.runtime.dis.itmuni

int

expert

modflownwt

link

modflownwt.runtime.bas

BasConfig

expert

modflownwt

link

modflownwt.runtime.bas.hnoflo

float

expert

modflownwt

link

modflownwt.runtime.upw

UpwConfig

expert

modflownwt

link

modflownwt.runtime.upw.iphdry

int

expert

modflownwt

link

modflownwt.runtime.upw.hdry

float

expert

modflownwt

link

modflownwt.runtime.upw.layvka

int

expert

modflownwt

link

modflownwt.runtime.evt

EvtConfig

expert

modflownwt

link

modflownwt.runtime.evt.nevtop

int

expert

modflownwt

link

modflownwt.runtime.evt.ievt

int

expert

modflownwt

link

modflownwt.runtime.evt.ipakcb

int

expert

modflownwt

link

modflownwt.runtime.oc

OcConfig

expert

modflownwt

link

modflownwt.runtime.oc.compact

bool

expert

modflownwt

link

modflownwt.runtime.wel

WelConfig

expert

modflownwt

link

modflownwt.runtime.wel.ipakcb

int

expert

modflownwt

link

modflownwt.runtime.lmt

LmtConfig

expert

modflownwt

link

modflownwt.runtime.lmt.output_file_name

str

expert

modflownwt

link

modflownwt.runtime.lmt.extension

str

expert

modflownwt

link

modflownwt.runtime.lmt.output_format

str

expert

modflownwt

link

modflownwt.process_specific

ModflowProcessSpecificConfig

expert

modflownwt

link

modflownwt.process_specific.vka

float

expert

modflownwt

link

modflownwt.process_specific.exdp

float

expert

modflownwt

link

modflownwt.sgrid

SolverSGridConfig

user

modflownwt

link

modflownwt.sgrid.planar

PlanarGridConfig

user

modflownwt

link

modflownwt.sgrid.planar.mode

Literal['keep_native', 'resample_to_shape']

user

modflownwt

link

modflownwt.sgrid.planar.nx

Optional[int]

user

modflownwt

link

modflownwt.sgrid.planar.ny

Optional[int]

user

modflownwt

link

modflownwt.sgrid.planar.resampling

Literal['bilinear', 'average', 'nearest']

dev

modflownwt

link

modflownwt.sgrid.vertical

VerticalGridConfig

user

modflownwt

link

modflownwt.sgrid.vertical.genmtd_lay

Literal['constant', 'decay', 'list']

user

modflownwt

link

modflownwt.sgrid.vertical.nlay

int | None

user

modflownwt

link

modflownwt.sgrid.vertical.lay_decay

float | None

dev

modflownwt

link

modflownwt.sgrid.vertical.lay_proportions

list[float] | None

dev

modflownwt

link

modflownwt.sgrid.vertical.nodata

float

dev

modflownwt

link

modflownwt.tgrid

TMeshConfig | None

user

modflownwt

link

modflownwt.tgrid.itmuni

str

dev

modflownwt

link

modflownwt.tgrid.genmtd

Literal['synthetic_regular', 'from_chron']

user

modflownwt

link

modflownwt.tgrid.nper

int

user

modflownwt

link

modflownwt.tgrid.lenper

float | int | list[int] | list[float] | None

user

modflownwt

link

modflownwt.tgrid.chron_path

str | None

user

modflownwt

link

modflownwt.tgrid.chron_dateformat

str

dev

modflownwt

link

modflownwt.tgrid.chron_colsep

str

dev

modflownwt

link

modflownwt.tgrid.chron_time_col

str

dev

modflownwt

link

modflownwt.tgrid.start_datetime

Any | None

user

modflownwt

link

modflownwt.tgrid.end_datetime

Any | None

user

modflownwt

link

modflownwt.tgrid.tsmult

int | float | list[int] | list[float]

dev

modflownwt

link

modflownwt.tgrid.ntsp

int | list[int]

dev

modflownwt

link

modflownwt.tgrid.temporal_nodata

float

dev

modflownwt

link

modflow6.runtime

Modflow6RuntimeConfig

expert

modflow6

link

modflow6.runtime.mf6_executable_name

str

expert

modflow6

link

modflow6.runtime.mf6_ims_complexity

Literal['SIMPLE', 'MODERATE', 'COMPLEX']

expert

modflow6

link

modflow6.runtime.mf_verbose

bool

expert

modflow6

link

modflow6.runtime.mf6_outer_dvclose

float

expert

modflow6

link

modflow6.runtime.mf6_inner_dvclose

float

expert

modflow6

link

modflow6.runtime.mf6_outer_maximum

int

expert

modflow6

link

modflow6.runtime.mf6_inner_maximum

int

expert

modflow6

link

modflow6.runtime.mf6_inner_rclose

Optional[float]

expert

modflow6

link

modflow6.runtime.mf6_linear_acceleration

Optional[Literal['CG', 'BICGSTAB']]

expert

modflow6

link

modflow6.runtime.mf6_under_relaxation

Optional[Literal['NONE', 'SIMPLE', 'COOLEY', 'DBD']]

expert

modflow6

link

modflow6.runtime.mf6_enable_rewet

bool | None

expert

modflow6

link

modflow6.runtime.mf6_newton

bool

expert

modflow6

link

modflow6.runtime.mf6_newton_under_relaxation

bool

expert

modflow6

link

modflow6.runtime.mf6_enable_xt3d

bool | None

expert

modflow6

link

modflow6.runtime.mf6_rewet_wetfct

float

expert

modflow6

link

modflow6.runtime.mf6_rewet_iwetit

int

expert

modflow6

link

modflow6.runtime.mf6_rewet_ihdwet

int

expert

modflow6

link

modflow6.runtime.mf6_rewet_wetdry

float

expert

modflow6

link

modflow6.process_specific

Modflow6ProcessSpecificConfig

expert

modflow6

link

modflow6.process_specific.vka

float

expert

modflow6

link

modflow6.process_specific.evt_extinction_depth

float

expert

modflow6

link

modflow6.sgrid

SolverSGridConfig

user

modflow6

link

modflow6.sgrid.planar

PlanarGridConfig

user

modflow6

link

modflow6.sgrid.planar.mode

Literal['keep_native', 'resample_to_shape']

user

modflow6

link

modflow6.sgrid.planar.nx

Optional[int]

user

modflow6

link

modflow6.sgrid.planar.ny

Optional[int]

user

modflow6

link

modflow6.sgrid.planar.resampling

Literal['bilinear', 'average', 'nearest']

dev

modflow6

link

modflow6.sgrid.vertical

VerticalGridConfig

user

modflow6

link

modflow6.sgrid.vertical.genmtd_lay

Literal['constant', 'decay', 'list']

user

modflow6

link

modflow6.sgrid.vertical.nlay

int | None

user

modflow6

link

modflow6.sgrid.vertical.lay_decay

float | None

dev

modflow6

link

modflow6.sgrid.vertical.lay_proportions

list[float] | None

dev

modflow6

link

modflow6.sgrid.vertical.nodata

float

dev

modflow6

link

display.enabled

bool

user

display

link

display.backend

Literal['agg', 'qt5agg', 'auto']

dev

display

link

display.preset

Literal['default', 'print', 'dark']

user

display

link

display.show

bool

user

display

link

display.save

bool

user

display

link

display.output_dir

Path

user

display

link

display.dpi

int

dev

display

link

display.cmap

str

user

display

link

display.figures

list[str]

user

display

link

display.overrides

dict[str, dict]

expert

display

link

display.flow

DisplayFlowConfig

user

display

link

display.flow.enabled

bool

user

display

link

display.flow.cross_section

bool

user

display

link

display.flow.streamflow

bool

user

display

link

display.flow.piezometry

bool

user

display

link

display.flow.watertable_map

bool

user

display

link

display.flow.dem_map

bool

user

display

link

display.flow.budget

bool

user

display

link

display.flow.hydrography

bool

user

display

link

display.flow.boussinesq_state

bool

user

display

link

display.flow.boussinesq_diagnostics

bool

user

display

link

display.flow.boussinesq_mass_balance

bool

user

display

link

display.flow.boussinesq_probes

bool

user

display

link

display.flow.boussinesq_edge_flux

bool

user

display

link

display.particles

DisplayParticlesConfig

user

display

link

display.particles.enabled

bool

user

display

link

display.particles.pathlines

bool

user

display

link

display.transport

DisplayTransportConfig

user

display

link

display.transport.enabled

bool

user

display

link

display.transport.concentration

bool

user

display

link

display.transport.gif

bool

user

display

link

display.transport.web_animation

bool

user

display

link

persistence.save_catalog

bool

user

persistence

link

persistence.save_zarr

bool

user

persistence

link

persistence.save_parquet

bool

user

persistence

link

persistence.save_lock

bool

user

persistence

link

persistence.compression

Literal['none', 'zstd', 'lz4', 'gzip', 'snappy']

dev

persistence

link

persistence.compression_level

int

dev

persistence

link

analysis.batch

RegionalLabConfig | None

user

analysis

link

analysis.batch.config_path

Path

user

analysis

link

analysis.batch.base_dir

Path

user

analysis

link

analysis.batch.lab_id

str

user

analysis

link

analysis.batch.output_root

Path

user

analysis

link

analysis.batch.execute

bool

user

analysis

link

analysis.batch.continue_on_error

bool

user

analysis

link

analysis.batch.validate_config_paths

bool

user

analysis

link

analysis.batch.resume_from_report

bool

user

analysis

link

analysis.batch.skip_completed_cases

bool

user

analysis

link

analysis.batch.catalog

RegionalLabCatalogConfig

user

analysis

link

analysis.batch.catalog.path

Path

user

analysis

link

analysis.batch.catalog.format

Literal['auto', 'csv', 'jsonl']

user

analysis

link

analysis.batch.catalog.site_id_field

str

user

analysis

link

analysis.batch.catalog.site_label_field

str | None

user

analysis

link

analysis.batch.catalog.cluster_id_field

str | None

user

analysis

link

analysis.batch.catalog.cluster_label_field

str | None

user

analysis

link

analysis.batch.catalog.cluster_family_field

str | None

user

analysis

link

analysis.batch.catalog.cluster_scale_field

str | None

user

analysis

link

analysis.batch.catalog.region_field

str | None

user

analysis

link

analysis.batch.catalog.source_selection_field

str | None

user

analysis

link

analysis.batch.catalog.status_field

str | None

user

analysis

link

analysis.batch.catalog.maturity_field

str | None

user

analysis

link

analysis.batch.catalog.x_field

str | None

user

analysis

link

analysis.batch.catalog.y_field

str | None

user

analysis

link

analysis.batch.catalog.area_km2_field

str | None

user

analysis

link

analysis.batch.catalog.tags_field

str | None

user

analysis

link

analysis.batch.catalog.enabled_field

str | None

user

analysis

link

analysis.batch.catalog.required_fields

tuple[str, ...]

user

analysis

link

analysis.batch.catalog.path_fields

tuple[str, ...]

user

analysis

link

analysis.batch.catalog.tag_separator

str

user

analysis

link

analysis.batch.catalog.source_manifest_path

Path | None

user

analysis

link

analysis.batch.catalog.source_manifest_output_key

str | None

user

analysis

link

analysis.batch.selection

RegionalLabSelectionConfig

user

analysis

link

analysis.batch.selection.site_ids

tuple[str, ...]

user

analysis

link

analysis.batch.selection.cluster_ids

tuple[str, ...]

user

analysis

link

analysis.batch.selection.regions

tuple[str, ...]

user

analysis

link

analysis.batch.selection.families

tuple[str, ...]

user

analysis

link

analysis.batch.selection.scales

tuple[str, ...]

user

analysis

link

analysis.batch.selection.statuses

tuple[str, ...]

user

analysis

link

analysis.batch.selection.maturity_levels

tuple[str, ...]

user

analysis

link

analysis.batch.selection.tags

tuple[str, ...]

user

analysis

link

analysis.batch.selection.limit

int | None

user

analysis

link

analysis.batch.selection.include_disabled

bool

user

analysis

link

analysis.batch.cluster_rules

tuple[RegionalLabClusterRuleConfig, ...]

user

analysis

link

analysis.batch.cluster_rules.id

str

user

analysis

link

analysis.batch.cluster_rules.label

str

user

analysis

link

analysis.batch.cluster_rules.enabled

bool

user

analysis

link

analysis.batch.cluster_rules.priority

int

user

analysis

link

analysis.batch.cluster_rules.selection

RegionalLabSelectionConfig

user

analysis

link

analysis.batch.cluster_rules.selection.site_ids

tuple[str, ...]

user

analysis

link

analysis.batch.cluster_rules.selection.cluster_ids

tuple[str, ...]

user

analysis

link

analysis.batch.cluster_rules.selection.regions

tuple[str, ...]

user

analysis

link

analysis.batch.cluster_rules.selection.families

tuple[str, ...]

user

analysis

link

analysis.batch.cluster_rules.selection.scales

tuple[str, ...]

user

analysis

link

analysis.batch.cluster_rules.selection.statuses

tuple[str, ...]

user

analysis

link

analysis.batch.cluster_rules.selection.maturity_levels

tuple[str, ...]

user

analysis

link

analysis.batch.cluster_rules.selection.tags

tuple[str, ...]

user

analysis

link

analysis.batch.cluster_rules.selection.limit

int | None

user

analysis

link

analysis.batch.cluster_rules.selection.include_disabled

bool

user

analysis

link

analysis.batch.cluster_rules.field_equals

tuple[tuple[str, str], ...]

user

analysis

link

analysis.batch.cluster_rules.set_cluster_id

str | None

user

analysis

link

analysis.batch.cluster_rules.set_cluster_label

str | None

user

analysis

link

analysis.batch.cluster_rules.set_cluster_family

str | None

user

analysis

link

analysis.batch.cluster_rules.set_cluster_scale

str | None

user

analysis

link

analysis.batch.cluster_rules.cluster_tags

tuple[str, ...]

user

analysis

link

analysis.batch.cluster_rules.override_existing_cluster

bool

user

analysis

link

analysis.batch.recipes

tuple[RegionalLabRecipeConfig, ...]

user

analysis

link

analysis.batch.recipes.id

str

user

analysis

link

analysis.batch.recipes.label

str

user

analysis

link

analysis.batch.recipes.launcher

Literal['simulation', 'comparison']

user

analysis

link

analysis.batch.recipes.config_path_template

str

user

analysis

link

analysis.batch.recipes.enabled

bool

user

analysis

link

analysis.batch.recipes.selection

RegionalLabSelectionConfig

user

analysis

link

analysis.batch.recipes.selection.site_ids

tuple[str, ...]

user

analysis

link

analysis.batch.recipes.selection.cluster_ids

tuple[str, ...]

user

analysis

link

analysis.batch.recipes.selection.regions

tuple[str, ...]

user

analysis

link

analysis.batch.recipes.selection.families

tuple[str, ...]

user

analysis

link

analysis.batch.recipes.selection.scales

tuple[str, ...]

user

analysis

link

analysis.batch.recipes.selection.statuses

tuple[str, ...]

user

analysis

link

analysis.batch.recipes.selection.maturity_levels

tuple[str, ...]

user

analysis

link

analysis.batch.recipes.selection.tags

tuple[str, ...]

user

analysis

link

analysis.batch.recipes.selection.limit

int | None

user

analysis

link

analysis.batch.recipes.selection.include_disabled

bool

user

analysis

link

analysis.batch.recipes.required_fields

tuple[str, ...]

user

analysis

link

analysis.batch.recipes.allowed_platforms

tuple[str, ...]

user

analysis

link

analysis.capability_gallery

CapabilityGalleryConfig | None

user

analysis

link

analysis.capability_gallery.enabled

bool

user

analysis

link

analysis.capability_gallery.output_dir

Path | None

user

analysis

link

analysis.capability_gallery.case_slug

str

user

analysis

link

analysis.capability_gallery.assets

tuple[str, ...]

user

analysis

link

analysis.comparison

ComparisonSection | None

user

analysis

link

analysis.comparison.comparison_id

Optional[str]

user

analysis

link

analysis.comparison.base_simulation_config

str | None

expert

analysis

link

analysis.comparison.base_simulation_overlay

dict[str, Any]

expert

analysis

link

analysis.comparison.anchors_file

str | None

expert

analysis

link

analysis.comparison.output_root

str | None

expert

analysis

link

analysis.comparison.reference_simulation

Optional[str]

expert

analysis

link

analysis.comparison.continue_on_error

bool

dev

analysis

link

analysis.comparison.execution

ComparisonExecutionConfig

dev

analysis

link

analysis.comparison.execution.backend

Literal['subprocess_hmp_run']

dev

analysis

link

analysis.comparison.execution.max_parallel_runs

int

dev

analysis

link

analysis.comparison.execution.keep_generated_configs

bool

dev

analysis

link

analysis.comparison.execution.run_simulations

bool

dev

analysis

link

analysis.comparison.execution.python_executable

str | None

dev

analysis

link

analysis.comparison.execution.timeout_seconds

float | None

dev

analysis

link

analysis.comparison.audit

ComparisonAuditConfig

dev

analysis

link

analysis.comparison.audit.mode

Literal['strict_same_case']

dev

analysis

link

analysis.comparison.audit.on_mismatch

Literal['fail', 'warn', 'ignore']

dev

analysis

link

analysis.comparison.fine_raster

ComparisonFineRaster | None

expert

analysis

link

analysis.comparison.fine_raster.enabled

bool

expert

analysis

link

analysis.comparison.fine_raster.resolution

Optional[float]

expert

analysis

link

analysis.comparison.fine_raster.extent_mode

Literal['intersection', 'union', 'reference']

expert

analysis

link

analysis.comparison.fine_raster.interpolation

Literal['linear', 'nearest']

expert

analysis

link

analysis.comparison.fine_raster.write_geotiff

bool

expert

analysis

link

analysis.comparison.simulation

list[ComparisonSimulationConfig]

user

analysis

link

analysis.comparison.simulation.id

str

user

analysis

link

analysis.comparison.simulation.label

str | None

user

analysis

link

analysis.comparison.simulation.enabled

bool

user

analysis

link

analysis.comparison.simulation.solver

str | None

expert

analysis

link

analysis.comparison.simulation.simulation_config

str | None

expert

analysis

link

analysis.comparison.simulation.run_folder

str | None

expert

analysis

link

analysis.comparison.simulation.mesh_label

Optional[str]

user

analysis

link

analysis.comparison.simulation.mesh_mode

Literal['mesh_catchment', 'mesh_input', 'sgrid', 'structured', 'unstructured', 'unknown']

dev

analysis

link

analysis.comparison.simulation.overlay

dict[str, Any]

expert

analysis

link

analysis.comparison.observable

list[ComparisonObservable]

user

analysis

link

analysis.comparison.observable.name

str

user

analysis

link

analysis.comparison.observable.variable

str

user

analysis

link

analysis.comparison.observable.source

Literal['disk']

user

analysis

link

analysis.comparison.observable.simulations

list[str] | None

user

analysis

link

analysis.comparison.observable.support

Literal['point', 'outlet', 'boundary', 'cell_mask', 'map']

user

analysis

link

analysis.comparison.observable.anchor_id

str | None

user

analysis

link

analysis.comparison.observable.x

float | None

user

analysis

link

analysis.comparison.observable.y

float | None

user

analysis

link

analysis.comparison.observable.cell_index

Optional[int]

user

analysis

link

analysis.comparison.observable.cell_indices

list[int] | None

user

analysis

link

analysis.comparison.observable.boundary_id

Optional[str]

user

analysis

link

analysis.comparison.observable.allow_domain_proxy

bool

dev

analysis

link

analysis.comparison.observable.time

str | int | None

user

analysis

link

analysis.comparison.observable.time_window

tuple[str, str] | tuple[float, float] | None

user

analysis

link

analysis.comparison.observable.reducer

str | None

user

analysis

link

analysis.comparison.observable.time_reducer

str | None

user

analysis

link

analysis.comparison.observable.unit

str | None

user

analysis

link

overview.name

str

user

overview

link

overview.date_start

str | None

user

overview

link

overview.date_end

str | None

user

overview

link

overview.regional_context_label

str | None

user

overview

link

overview.panels

OverviewPanelsConfig

user

overview

link

overview.panels.map_dem

bool

user

overview

link

overview.panels.map_geology

bool

user

overview

link

overview.panels.map_hydrography

bool

user

overview

link

overview.panels.stats_card

bool

user

overview

link

overview.panels.timeseries_discharge

bool

user

overview

link

overview.panels.timeseries_piezometry

bool

user

overview

link

overview.panels.climatic_summary

bool

user

overview

link

overview.panels.timeseries_intermittency

bool

user

overview

link

overview.panels.timeseries_water_quality

bool

user

overview

link

overview.panels.station_inventory

bool

user

overview

link

mesh_catchment.constraints_mode

Literal['geology_only', 'rivers_only', 'geology_rivers']

user

mesh_catchment

link

mesh_catchment.output_mesh

Optional[str]

dev

mesh_catchment

link

mesh_catchment.output_summary_json

Optional[str]

dev

mesh_catchment

link

mesh_catchment.output_figure

Optional[str]

dev

mesh_catchment

link

mesh_catchment.output_figure_regional

Optional[str]

dev

mesh_catchment

link

mesh_catchment.figures_enabled

bool

user

mesh_catchment

link

mesh_catchment.export_exchange_bundle

bool

user

mesh_catchment

link

mesh_catchment.figure_dpi

int

user

mesh_catchment

link

mesh_catchment.figure_regional_dpi

int

user

mesh_catchment

link

mesh_catchment.output_layout

Literal['standard', 'flat']

user

mesh_catchment

link

mesh_catchment.show_plot

bool

user

mesh_catchment

link

mesh_catchment.geographic_outputs_mode

Literal['keep', 'cleanup']

dev

mesh_catchment

link

mesh_catchment.rivers

MeshCatchmentRiversConfig

user

mesh_catchment

link

mesh_catchment.rivers.source

Literal['geographic_features', 'file']

user

mesh_catchment

link

mesh_catchment.rivers.path

Optional[str]

user

mesh_catchment

link

mesh_catchment.rivers.clip_to_domain

bool

user

mesh_catchment

link

mesh_catchment.rivers.min_segment_length

Any

user

mesh_catchment

link

mesh_catchment.rivers.snap_tolerance

Any

user

mesh_catchment

link

mesh_catchment.geology

dict[str, Any] | None

user

mesh_catchment

link

mesh_catchment.watershed_boundary

MeshCatchmentWatershedBoundaryConfig

user

mesh_catchment

link

mesh_catchment.watershed_boundary.enabled

bool

user

mesh_catchment

link

mesh_catchment.watershed_boundary.boundary_refinement_distance

Optional[Any]

dev

mesh_catchment

link

mesh_catchment.watershed_boundary.smoothing

MeshCatchmentWatershedBoundarySmoothingConfig

user

mesh_catchment

link

mesh_catchment.watershed_boundary.smoothing.enabled

bool

user

mesh_catchment

link

mesh_catchment.watershed_boundary.smoothing.distance

Optional[Any]

dev

mesh_catchment

link

mesh_catchment.watershed_boundary.smoothing.river_buffer_distance

Optional[Any]

dev

mesh_catchment

link

mesh_catchment.watershed_boundary.smoothing.outer_bias_distance

Optional[Any]

dev

mesh_catchment

link

mesh_catchment.watershed_boundary.outside_coarsening

MeshCatchmentWatershedOutsideCoarseningConfig

user

mesh_catchment

link

mesh_catchment.watershed_boundary.outside_coarsening.enabled

bool

user

mesh_catchment

link

mesh_catchment.watershed_boundary.outside_coarsening.size_factor

float

dev

mesh_catchment

link

mesh_catchment.watershed_boundary.outside_coarsening.transition_distance

Optional[Any]

dev

mesh_catchment

link

mesh_catchment.watershed_boundary.outside_coarsening.grid_resolution

Optional[Any]

dev

mesh_catchment

link

mesh_catchment.watershed_boundary.geology_conformity

MeshCatchmentWatershedGeologyConformityConfig

user

mesh_catchment

link

mesh_catchment.watershed_boundary.geology_conformity.mode

Literal['full_domain', 'buffered_watershed_envelope']

user

mesh_catchment

link

mesh_catchment.watershed_boundary.geology_conformity.buffer_distance

Optional[Any]

dev

mesh_catchment

link

mesh_catchment.hydraulic_properties

MeshCatchmentHydraulicPropertiesConfig | None

user

mesh_catchment

link

mesh_catchment.hydraulic_properties.conductivity

MeshCatchmentHydraulicConductivity | None

user

mesh_catchment

link

mesh_catchment.hydraulic_properties.conductivity.values_source

Literal['inline', 'csv']

user

mesh_catchment

link

mesh_catchment.hydraulic_properties.conductivity.values

dict[str, object] | None

user

mesh_catchment

link

mesh_catchment.hydraulic_properties.conductivity.values_csv_file

Optional[str]

dev

mesh_catchment

link

mesh_catchment.hydraulic_properties.conductivity.csv_key_column

str

dev

mesh_catchment

link

mesh_catchment.hydraulic_properties.conductivity.csv_value_column

str

dev

mesh_catchment

link

mesh_catchment.hydraulic_properties.conductivity.default_value

object | None

user

mesh_catchment

link

mesh_catchment.hydraulic_properties.conductivity.unit

str

dev

mesh_catchment

link

mesh_catchment.hydraulic_properties.storage_coefficient

MeshCatchmentStorageCoefficient | None

user

mesh_catchment

link

mesh_catchment.hydraulic_properties.storage_coefficient.values_source

Literal['inline', 'csv']

user

mesh_catchment

link

mesh_catchment.hydraulic_properties.storage_coefficient.values

dict[str, object] | None

user

mesh_catchment

link

mesh_catchment.hydraulic_properties.storage_coefficient.values_csv_file

Optional[str]

dev

mesh_catchment

link

mesh_catchment.hydraulic_properties.storage_coefficient.csv_key_column

str

dev

mesh_catchment

link

mesh_catchment.hydraulic_properties.storage_coefficient.csv_value_column

str

dev

mesh_catchment

link

mesh_catchment.hydraulic_properties.storage_coefficient.default_value

object | None

user

mesh_catchment

link

mesh_catchment.domain

ZoneMeshingDomainBBox | ZoneMeshingDomainPolygon | ZoneMeshingDomainVector | ZoneMeshingDomainGeographicBoxBuffer | ZoneMeshingDomainGeographicWatershed | ZoneMeshingDomainGeographicWatershedBox

user

mesh_catchment

link

mesh_catchment.domain.bbox.kind

Literal['bbox']

user

mesh_catchment

link

mesh_catchment.domain.bbox.bbox

list[float]

user

mesh_catchment

link

mesh_catchment.domain.polygon.kind

Literal['polygon']

user

mesh_catchment

link

mesh_catchment.domain.polygon.coordinates

list[list[float]]

user

mesh_catchment

link

mesh_catchment.domain.vector.kind

Literal['vector']

user

mesh_catchment

link

mesh_catchment.domain.vector.path

str

user

mesh_catchment

link

mesh_catchment.domain.vector.id_field

Optional[str]

user

mesh_catchment

link

mesh_catchment.domain.vector.selected_id

Optional[str]

user

mesh_catchment

link

mesh_catchment.domain.geographic_box_buffer.kind

Literal['geographic_box_buffer']

user

mesh_catchment

link

mesh_catchment.domain.geographic_watershed.kind

Literal['geographic_watershed']

user

mesh_catchment

link

mesh_catchment.domain.geographic_watershed_box.kind

Literal['geographic_watershed_box']

user

mesh_catchment

link

mesh_catchment.zone_meshing

ZoneMeshingSettings

dev

mesh_catchment

link

mesh_catchment.zone_meshing.algorithm

str

user

mesh_catchment

link

mesh_catchment.zone_meshing.global_size

float

user

mesh_catchment

link

mesh_catchment.zone_meshing.min_size

Optional[float]

user

mesh_catchment

link

mesh_catchment.zone_meshing.max_size

Optional[float]

user

mesh_catchment

link

mesh_catchment.zone_meshing.simplify_tolerance

float

dev

mesh_catchment

link

mesh_catchment.zone_meshing.heal_tolerance

float

dev

mesh_catchment

link

mesh_catchment.zone_meshing.linear_constraint_snap_tolerance

float

dev

mesh_catchment

link

mesh_catchment.zone_meshing.min_polygon_area

float

dev

mesh_catchment

link

mesh_catchment.zone_meshing.refine_interfaces

bool

user

mesh_catchment

link

mesh_catchment.zone_meshing.interface_size

Optional[float]

dev

mesh_catchment

link

mesh_catchment.zone_meshing.interface_distance

Optional[float]

dev

mesh_catchment

link

mesh_catchment.zone_meshing.interface_sampling

int

dev

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy

ZoneMeshingRefinementPolicy | None

user

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.enabled

bool

user

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.mode

Literal['family_priority_local_budget', 'grid_local_budget']

user

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.hotspot

ZoneMeshingRefinementHotspotSettings

dev

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.hotspot.radius

Optional[float]

dev

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.hotspot.max_curve_count

int

dev

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.hotspot.max_family_count

int

dev

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.hotspot.min_gap

float

dev

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.hotspot.max_node_degree

int

dev

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.hotspot.short_segment_length

float

dev

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.hotspot.max_short_segment_count

int

dev

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.grid

ZoneMeshingRefinementGridSettings

user

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.grid.cell_size

Optional[float]

user

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.grid.neighborhood_rings

int

dev

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.grid.enable_exact_gap_check

bool

dev

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.grid.max_exact_gap_candidates

int

dev

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.families

dict[str, ZoneMeshingRefinementFamilySettings]

user

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.families.<id>.enabled

bool

user

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.families.<id>.priority

int

user

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.families.<id>.interface_size

Optional[float]

dev

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.families.<id>.interface_distance

Optional[float]

dev

mesh_catchment

link

mesh_catchment.zone_meshing.refinement_policy.families.<id>.interface_sampling

int | None

dev

mesh_catchment

link

mesh_input.mesh_path

Path | None

user

mesh_input

link

mesh_input.bundle_dir

Path | None

user

mesh_input

link

calibration.method

str

user

calibration

link

calibration.max_iter

int

user

calibration

link

calibration.batch_size

int

dev

calibration

link

calibration.parallel

int

dev

calibration

link

calibration.seed

int | None

user

calibration

link

calibration.save_runs

Literal['none', 'best_n', 'all']

user

calibration

link

calibration.save_best_n

int

user

calibration

link

calibration.use_cache

bool

dev

calibration

link

calibration.lightweight_extraction

bool

dev

calibration

link

calibration.objective

str

user

calibration

link

calibration.variable

str

user

calibration

link

calibration.optimizer_kwargs

dict[str, Any]

dev

calibration

link

calibration.parameters

dict[str, CalibParameterDecl]

user

calibration

link

calibration.parameters.<id>.bounds

list[float] | None

user

calibration

link

calibration.parameters.<id>.transform

Literal['identity', 'log', 'logit']

user

calibration

link

calibration.parameters.<id>.prior

Literal['uniform', 'log_uniform', 'normal']

user

calibration

link

calibration.parameters.<id>.path

str | None

user

calibration

link

calibration.parameters.<id>.target

str | None

user

calibration

link

calibration.parameters.<id>.mode

Literal['replace', 'scale']

user

calibration

link

calibration.parameters.<id>.units

str | None

user

calibration

link

calibration.outputs

dict[str, CalibOutputPoint | CalibOutputBoundary | CalibOutputCell]

user

calibration

link

calibration.outputs.point.<id>.variable

str

user

calibration

link

calibration.outputs.point.<id>.support

Literal['point']

user

calibration

link

calibration.outputs.point.<id>.geometry

dict[str, Any] | None

user

calibration

link

calibration.outputs.point.<id>.x

Optional[Any]

user

calibration

link

calibration.outputs.point.<id>.y

Optional[Any]

user

calibration

link

calibration.outputs.point.<id>.time

Union[Literal['all', 'last', 'first'], list[str]]

user

calibration

link

calibration.outputs.point.<id>.reducer

Literal['mean', 'sum', 'last', 'none']

user

calibration

link

calibration.outputs.point.<id>.observed_values

list[float] | None

user

calibration

link

calibration.outputs.boundary.<id>.variable

str

user

calibration

link

calibration.outputs.boundary.<id>.support

Literal['boundary']

user

calibration

link

calibration.outputs.boundary.<id>.boundary_id

str

user

calibration

link

calibration.outputs.boundary.<id>.time

Union[Literal['all', 'last', 'first'], list[str]]

user

calibration

link

calibration.outputs.boundary.<id>.reducer

Literal['mean', 'sum', 'last', 'none']

user

calibration

link

calibration.outputs.boundary.<id>.observed_values

list[float] | None

user

calibration

link

calibration.outputs.cell.<id>.variable

str

user

calibration

link

calibration.outputs.cell.<id>.support

Literal['cell']

user

calibration

link

calibration.outputs.cell.<id>.cell_id

Optional[int]

user

calibration

link

calibration.outputs.cell.<id>.row

Optional[int]

user

calibration

link

calibration.outputs.cell.<id>.col

Optional[int]

user

calibration

link

calibration.outputs.cell.<id>.layer

int

user

calibration

link

calibration.outputs.cell.<id>.time

Union[Literal['all', 'last', 'first'], list[str]]

user

calibration

link

calibration.outputs.cell.<id>.reducer

Literal['mean', 'sum', 'last', 'none']

user

calibration

link

calibration.outputs.cell.<id>.observed_values

list[float] | None

user

calibration

link

calibration.objective_blocks

list[CalibObjectiveBlockDecl]

user

calibration

link

calibration.objective_blocks.name

str

user

calibration

link

calibration.objective_blocks.metric

Literal['rmse', 'nse', 'kge', 'mae']

user

calibration

link

calibration.objective_blocks.weight

float

user

calibration

link

calibration.objective_blocks.uses_outputs

list[str]

user

calibration

link

calibration.objective_blocks.normalize_cost

bool

user

calibration

link

calibration.objective_blocks.transform

Literal['identity', 'log', 'inverse']

user

calibration

link

calibration.persist_iteration_detail

Literal['none', 'summary', 'full']

dev

calibration

link

calibration.persist_model_distribution

bool

dev

calibration

link

calibration.rerun_best_with_outputs

bool

user

calibration

link

calibration.materialize_candidates

bool

dev

calibration

link

calibration.candidates_root

PurePosixPath | None

dev

calibration

link

calibration.persistence

PersistenceConfig

user

calibration

link

calibration.persistence.save_catalog

bool

user

calibration

link

calibration.persistence.save_zarr

bool

user

calibration

link

calibration.persistence.save_parquet

bool

user

calibration

link

calibration.persistence.save_lock

bool

user

calibration

link

calibration.persistence.compression

Literal['none', 'zstd', 'lz4', 'gzip', 'snappy']

dev

calibration

link

calibration.persistence.compression_level

int

dev

calibration

link

testbed.config_path

Path

user

testbed

link

testbed.base_dir

Path

user

testbed

link

testbed.id

str

user

testbed

link

testbed.profile

str

user

testbed

link

testbed.subject

str

user

testbed

link

testbed.purpose

str

user

testbed

link

testbed.output_root

Path

user

testbed

link

testbed.execute

bool

user

testbed

link

testbed.continue_on_error

bool

user

testbed

link

testbed.base_config_path

Path | None

user

testbed

link

testbed.runner

TestbedRunnerConfig

user

testbed

link

testbed.runner.type

str

user

testbed

link

testbed.runner.no_display

bool

user

testbed

link

testbed.case

tuple[TestbedCaseConfig, ...]

user

testbed

link

testbed.case.id

str

user

testbed

link

testbed.case.label

str

user

testbed

link

testbed.case.axis

str | None

user

testbed

link

testbed.case.enabled

bool

user

testbed

link

testbed.case.overlay

dict[str, Any]

user

testbed

link

testbed.catalog

TestbedCatalogConfig | None

user

testbed

link

testbed.catalog.path

Path

user

testbed

link

testbed.catalog.format

str

user

testbed

link

testbed.catalog.id_field

str

user

testbed

link

testbed.catalog.label_field

str | None

user

testbed

link

testbed.catalog.axis_field

str | None

user

testbed

link

testbed.catalog.enabled_field

str | None

user

testbed

link

testbed.catalog.tags_field

str | None

user

testbed

link

testbed.catalog.required_fields

tuple[str, ...]

user

testbed

link

testbed.catalog.path_fields

tuple[str, ...]

user

testbed

link

testbed.catalog.tag_separator

str

user

testbed

link

testbed.catalog.field_equals

tuple[tuple[str, str], ...]

user

testbed

link

testbed.catalog.tags

tuple[str, ...]

user

testbed

link

testbed.catalog.exclude_tags

tuple[str, ...]

user

testbed

link

testbed.catalog.include_disabled

bool

user

testbed

link

testbed.catalog.limit

int | None

user

testbed

link

testbed.catalog.source_manifest_path

Path | None

user

testbed

link

testbed.catalog.source_manifest_output_key

str | None

user

testbed

link

testbed.case_from_catalog

tuple[TestbedCatalogCaseConfig, ...]

user

testbed

link

testbed.case_from_catalog.id_template

str | None

user

testbed

link

testbed.case_from_catalog.label_template

str | None

user

testbed

link

testbed.case_from_catalog.axis_template

str | None

user

testbed

link

testbed.case_from_catalog.enabled

bool

user

testbed

link

testbed.case_from_catalog.overlay

dict[str, Any]

user

testbed

link

testbed.case_from_catalog.required_fields

tuple[str, ...]

user

testbed

link

testbed.case_from_catalog.field_equals

tuple[tuple[str, str], ...]

user

testbed

link

testbed.case_from_catalog.tags

tuple[str, ...]

user

testbed

link

testbed.case_from_catalog.exclude_tags

tuple[str, ...]

user

testbed

link

testbed.case_from_catalog.limit

int | None

user

testbed

link

testbed.metrics

tuple[TestbedMetricConfig, ...]

user

testbed

link

testbed.metrics.name

str

user

testbed

link

testbed.metrics.source

str

user

testbed

link

testbed.metrics.required

bool

user

testbed

link

site_selection.selection_id

str

user

site_selection

link

site_selection.output_root

Path

user

site_selection

link

site_selection.random_seed

int | None

user

site_selection

link

site_selection.strategy

StrategyConfig

user

site_selection

link

site_selection.strategy.principle

Literal['observation_led', 'criteria_crossing']

user

site_selection

link

site_selection.strategy.profile

Optional[Literal['area_only', 'gauged_downstream_station']]

user

site_selection

link

site_selection.strategy.primary_axes

list[str]

user

site_selection

link

site_selection.strategy.observation_role

Literal['primary', 'bonus', 'score', 'stratify', 'report_only', 'ignore']

user

site_selection

link

site_selection.strategy.geology_role

Literal['primary', 'bonus', 'score', 'stratify', 'report_only', 'ignore']

user

site_selection

link

site_selection.strategy.primary_observation_type

str | None

user

site_selection

link

site_selection.strategy.observation_source

str | None

user

site_selection

link

site_selection.strategy.candidate_mode

Optional[Literal['network_sampling', 'station_outlets']]

user

site_selection

link

site_selection.territory

TerritoryConfig

user

site_selection

link

site_selection.territory.mode

Literal['admin_regions', 'admin_departments', 'polygon_file', 'bbox']

user

site_selection

link

site_selection.territory.country

str | None

user

site_selection

link

site_selection.territory.regions

list[str]

user

site_selection

link

site_selection.territory.departments

list[str]

user

site_selection

link

site_selection.territory.polygon_file

Path | None

user

site_selection

link

site_selection.territory.bbox

tuple[float, float, float, float] | None

user

site_selection

link

site_selection.territory.clip_to_territory

bool

user

site_selection

link

site_selection.dem

DemConfig

user

site_selection

link

site_selection.dem.source

Literal['custom', 'data', 'ign_geoplateforme_dem']

user

site_selection

link

site_selection.dem.path

Path | None

user

site_selection

link

site_selection.dem.resolution_m

float | None

user

site_selection

link

site_selection.dem.cache_policy

str

user

site_selection

link

site_selection.dem.margin_km

float

user

site_selection

link

site_selection.dem.request_extent

Literal['territory', 'outlets']

user

site_selection

link

site_selection.dem.map_background_extent

Literal['none', 'delineation', 'territory']

user

site_selection

link

site_selection.dem.force_refresh

bool

user

site_selection

link

site_selection.hydrology

HydrologyConfig

user

site_selection

link

site_selection.hydrology.method

Literal['dem_only']

user

site_selection

link

site_selection.hydrology.flow_algorithm

Literal['d8']

user

site_selection

link

site_selection.hydrology.hydrologic_conditioning

Literal['existing_default', 'fill', 'breach']

user

site_selection

link

site_selection.hydrology.network_threshold_area_km2

float

user

site_selection

link

site_selection.hydrology.compute_strahler

bool

user

site_selection

link

site_selection.dem_area_light

DemAreaLightConfig | None

user

site_selection

link

site_selection.dem_area_light.target_area_km2

float

user

site_selection

link

site_selection.dem_area_light.min_area_km2

float

user

site_selection

link

site_selection.dem_area_light.max_area_km2

float

user

site_selection

link

site_selection.dem_area_light.n_basins

int

user

site_selection

link

site_selection.dem_area_light.max_candidates_before_delineation

int | None

user

site_selection

link

site_selection.input

SiteSelectionInputConfig

user

site_selection

link

site_selection.input.mode

Literal['plan_only', 'hydrometry', 'delineated_catchments', 'generated_candidates', 'dem_area_light']

user

site_selection

link

site_selection.input.catchments_csv

Path | None

user

site_selection

link

site_selection.input.region_id

str

user

site_selection

link

site_selection.input.workspace_root

Path | None

user

site_selection

link

site_selection.input.data_root

Path | None

user

site_selection

link

site_selection.input.write_plan_manifest

bool

user

site_selection

link

site_selection.input.delineate_from_outlets

bool

user

site_selection

link

site_selection.outlets

OutletsConfig

user

site_selection

link

site_selection.outlets.candidate_mode

Literal['network_sampling', 'station_outlets']

user

site_selection

link

site_selection.outlets.min_distance_between_outlets_km

float | None

user

site_selection

link

site_selection.outlets.allow_nested_basins

bool

user

site_selection

link

site_selection.outlets.max_generated_candidates

int | None

user

site_selection

link

site_selection.outlets.max_rejected_candidate_audit_records

int | None

user

site_selection

link

site_selection.outlets.max_generated_network_cells

int | None

user

site_selection

link

site_selection.outlets.snap_to_generated_stream

bool

user

site_selection

link

site_selection.outlets.snap_strategy

Literal['dem_accumulation', 'bdtopage_then_dem']

user

site_selection

link

site_selection.outlets.snap_dist_m

int

user

site_selection

link

site_selection.outlets.reference_network_source

Literal['bdtopage', 'custom']

user

site_selection

link

site_selection.outlets.reference_network_path

Path | None

user

site_selection

link

site_selection.outlets.reference_network_max_distance_m

float

user

site_selection

link

site_selection.outlets.reference_network_fetch_margin_m

float

user

site_selection

link

site_selection.outlets.reference_network_page_size

int

dev

site_selection

link

site_selection.outlets.reference_network_force_refresh

bool

dev

site_selection

link

site_selection.spatial_selection

SpatialSelectionConfig

user

site_selection

link

site_selection.spatial_selection.max_selected_sites

int | None

user

site_selection

link

site_selection.spatial_selection.allow_nested_basins

bool

user

site_selection

link

site_selection.spatial_selection.min_outlet_distance_km

float | None

user

site_selection

link

site_selection.spatial_selection.max_pairwise_basin_overlap_fraction

float | None

user

site_selection

link

site_selection.spatial_selection.overlap_reference

Literal['smaller_basin', 'candidate', 'selected']

user

site_selection

link

site_selection.spatial_selection.overlap_mode

Literal['hard_reject', 'warning', 'score', 'report_only']

user

site_selection

link

site_selection.spatial_selection.spatial_quota_mode

Literal['none', 'grid']

user

site_selection

link

site_selection.spatial_selection.spatial_quota_cell_size_km

float | None

user

site_selection

link

site_selection.spatial_selection.spatial_quota_max_sites_per_cell

int

user

site_selection

link

site_selection.criteria

CriteriaConfig

user

site_selection

link

site_selection.criteria.ruleset

str

user

site_selection

link

site_selection.criteria.hard_reject

list[str]

user

site_selection

link

site_selection.criteria.warning

list[str]

user

site_selection

link

site_selection.criteria.soft_score

list[str]

user

site_selection

link

site_selection.criteria.report_only

list[str]

user

site_selection

link

site_selection.criteria.area

AreaCriteriaConfig

user

site_selection

link

site_selection.criteria.area.mode

Literal['hard_reject', 'warning', 'score', 'stratify', 'report_only']

user

site_selection

link

site_selection.criteria.area.target_area_km2

float | None

user

site_selection

link

site_selection.criteria.area.preferred_area_km2

float | None

user

site_selection

link

site_selection.criteria.area.score_half_width_fraction

float | None

user

site_selection

link

site_selection.criteria.area.hard_min_area_km2

float | None

user

site_selection

link

site_selection.criteria.area.hard_max_area_km2

float | None

user

site_selection

link

site_selection.criteria.area.ranges

list[AreaRangeConfig]

user

site_selection

link

site_selection.criteria.area.ranges.range_id

str

user

site_selection

link

site_selection.criteria.area.ranges.label

str

user

site_selection

link

site_selection.criteria.area.ranges.min_area_km2

float

user

site_selection

link

site_selection.criteria.area.ranges.max_area_km2

float

user

site_selection

link

site_selection.criteria.observations

ObservationsCriteriaConfig

user

site_selection

link

site_selection.criteria.observations.flow_station_mode

Literal['hard_reject', 'warning', 'score', 'stratify', 'report_only']

user

site_selection

link

site_selection.criteria.observations.flow_station_max_distance_km

float | None

user

site_selection

link

site_selection.criteria.observations.piezometer_mode

Literal['hard_reject', 'warning', 'score', 'stratify', 'report_only']

user

site_selection

link

site_selection.criteria.observations.piezometer_max_distance_km

float | None

user

site_selection

link

site_selection.criteria.observations.flow_station

FlowStationCriteriaConfig

user

site_selection

link

site_selection.criteria.observations.flow_station.mode

Literal['hard_reject', 'warning', 'score', 'stratify', 'report_only']

user

site_selection

link

site_selection.criteria.observations.flow_station.min_record_years

float | None

user

site_selection

link

site_selection.criteria.observations.flow_station.max_station_to_outlet_distance_km

float | None

user

site_selection

link

site_selection.criteria.observations.flow_station.require_station_inside_or_at_outlet

bool

user

site_selection

link

site_selection.criteria.observations.station_influence

StationInfluenceCriteriaConfig

user

site_selection

link

site_selection.criteria.observations.station_influence.mode

Literal['hard_reject', 'warning', 'score', 'stratify', 'report_only']

user

site_selection

link

site_selection.criteria.observations.station_influence.source

str

user

site_selection

link

site_selection.criteria.observations.station_influence.warn_if_general_influence

bool

user

site_selection

link

site_selection.criteria.observations.station_influence.warn_if_local_influence

bool

user

site_selection

link

site_selection.criteria.observations.station_influence.warn_if_comment_keyword

bool

user

site_selection

link

site_selection.criteria.observations.station_influence.unknown_policy

Literal['neutral', 'warning']

user

site_selection

link

site_selection.criteria.observations.station_influence.comment_keywords

list[str]

user

site_selection

link

site_selection.criteria.observations.piezometer_layers

list[PiezometerLayerConfig]

user

site_selection

link

site_selection.criteria.observations.piezometer_layers.name

str

user

site_selection

link

site_selection.criteria.observations.piezometer_layers.path

Path

user

site_selection

link

site_selection.criteria.observations.piezometer_layers.id_field

str | None

user

site_selection

link

site_selection.criteria.observations.piezometer_layers.label_field

str | None

user

site_selection

link

site_selection.criteria.observations.piezometer_layers.record_years_field

str | None

user

site_selection

link

site_selection.criteria.observations.piezometer_layers.quality_field

str | None

user

site_selection

link

site_selection.criteria.influence

InfluenceCriteriaConfig

user

site_selection

link

site_selection.criteria.influence.mode

Literal['hard_reject', 'warning', 'score', 'stratify', 'report_only']

user

site_selection

link

site_selection.criteria.influence.reject_major_dam_upstream

bool

user

site_selection

link

site_selection.criteria.influence.reject_major_withdrawal_upstream

bool

user

site_selection

link

site_selection.criteria.influence.reject_major_regulated_reach

bool

user

site_selection

link

site_selection.criteria.influence.influence_search_radius_km

float | None

user

site_selection

link

site_selection.criteria.influence.layers

list[InfluenceLayerConfig]

user

site_selection

link

site_selection.criteria.influence.layers.name

str

user

site_selection

link

site_selection.criteria.influence.layers.path

Path

user

site_selection

link

site_selection.criteria.influence.layers.influence_type

Literal['major_dam_upstream', 'major_withdrawal_upstream', 'major_regulated_reach']

user

site_selection

link

site_selection.criteria.influence.layers.id_field

str | None

user

site_selection

link

site_selection.criteria.influence.layers.label_field

str | None

user

site_selection

link

site_selection.criteria.influence.layers.severity_field

str | None

user

site_selection

link

site_selection.criteria.influence.layers.major_values

list[str]

user

site_selection

link

site_selection.criteria.geology

GeologyCriteriaConfig

user

site_selection

link

site_selection.criteria.geology.mode

Literal['hard_reject', 'warning', 'score', 'stratify', 'report_only']

user

site_selection

link

site_selection.criteria.geology.prefer_diversity

bool

user

site_selection

link

site_selection.criteria.geology.layers

list[GeologyLayerConfig]

user

site_selection

link

site_selection.criteria.geology.layers.name

str

user

site_selection

link

site_selection.criteria.geology.layers.path

Path

user

site_selection

link

site_selection.criteria.geology.layers.class_field

str

user

site_selection

link

site_selection.criteria.geology.layers.id_field

str | None

user

site_selection

link

site_selection.criteria.geology.layers.label_field

str | None

user

site_selection

link

site_selection.output

OutputConfig

user

site_selection

link

site_selection.output.write_rejected

bool

user

site_selection

link

site_selection.output.write_selected

bool

user

site_selection

link

site_selection.output.write_geojson

bool

user

site_selection

link

site_selection.output.write_geoparquet

bool

user

site_selection

link

site_selection.output.write_geopackage

bool

user

site_selection

link

site_selection.output.write_csv

bool

user

site_selection

link

site_selection.output.write_regional_lab_csv

bool

user

site_selection

link

site_selection.output.write_report_html

bool

user

site_selection

link

site_selection.output.keep_intermediate_rasters

bool

user

site_selection

link

site_selection.map_context

MapContextConfig

user

site_selection

link

site_selection.map_context.layers

list[MapContextLayerConfig]

user

site_selection

link

site_selection.map_context.layers.name

str

user

site_selection

link

site_selection.map_context.layers.path

Path

user

site_selection

link

site_selection.map_context.layers.role

Literal['territory', 'hydrography', 'geology', 'other']

user

site_selection

link

site_selection.map_context.layers.label_field

str | None

user

site_selection

link

hydrometry.date_start

str | None

user

hydrometry

link

hydrometry.date_end

str | None

user

hydrometry

link

hydrometry.sources

list[HydrometrySourceConfig]

user

hydrometry

link

hydrometry.sources.fallback_search_radius_km

float | None

dev

hydrometry

link

hydrometry.sources.station_ids

list[str] | None

user

hydrometry

link

hydrometry.sources.extent

Optional[Literal['watershed', 'study_area']]

user

hydrometry

link

hydrometry.sources.force_refresh

bool

dev

hydrometry

link

hydrometry.sources.mask_path

Path | None

user

hydrometry

link

hydrometry.sources.source_unit

str | None

user

hydrometry

link

hydrometry.sources.col_id

str

dev

hydrometry

link

hydrometry.sources.col_x

str

dev

hydrometry

link

hydrometry.sources.col_y

str

dev

hydrometry

link

hydrometry.sources.col_crs

str

dev

hydrometry

link

hydrometry.sources.col_datetime

str

dev

hydrometry

link

hydrometry.sources.col_value

str

dev

hydrometry

link

hydrometry.sources.default_crs

str

dev

hydrometry

link

hydrometry.sources.source

Literal['custom', 'hubeau']

user

hydrometry

link

hydrometry.sources.path

Path | None

user

hydrometry

link

hydrometry.sources.product

str | None

user

hydrometry

link

hydrometry.sources.require_observations

bool

dev

hydrometry

link

hydrometry.sources.max_stations

int | None

user

hydrometry

link