panache.config

Functions

build_parameters(raw_parameters)
load_run_config(config_path)

Classes

RunConfig(input_path, bathymetry_path, ...)

class panache.config.RunConfig(input_path: 'str', bathymetry_path: 'Path', output_dir: 'Path', overwrite: 'bool', gif: 'bool', nb_cores: 'int' = 1, dynamic_threshold: 'bool' = False, annual_map_path: 'Path | None' = None, coast_shapefile: 'Path | None' = None, variable_name: 'str | None' = None, zone: 'str | None' = None, parameters: 'dict | None' = None, spm_threshold: 'float | None' = None, global_threshold_quantile: 'float | None' = None, near_mouth_lower_quantile: 'float' = 0.25, near_mouth_upper_quantile: 'float' = 0.75, gradient_steepness_fraction: 'float' = 0.9, near_mouth_window_shape: 'str' = 'circle', near_mouth_radius_pixels: 'int' = 15, mask_compression_level: 'int | None' = 4)

Bases: object

annual_map_path: Path | None = None

bathymetry_path: Path

coast_shapefile: Path | None = None

dynamic_threshold: bool = False

gif: bool

global_threshold_quantile: float | None = None

gradient_steepness_fraction: float = 0.9

input_path: str

mask_compression_level: int | None = 4

nb_cores: int = 1

near_mouth_lower_quantile: float = 0.25

near_mouth_radius_pixels: int = 15

near_mouth_upper_quantile: float = 0.75

near_mouth_window_shape: str = 'circle'

output_dir: Path

overwrite: bool

parameters: dict | None = None

spm_threshold: float | None = None

variable_name: str | None = None

zone: str | None = None

panache.config.build_parameters(raw_parameters: dict) → dict

panache.config.load_run_config(config_path: str | Path) → RunConfig