Configuration Setting

class pysewer.config.settings.Config(preprocessing: pysewer.config.settings.Preprocessing, optimization: pysewer.config.settings.Optimization, plotting: pysewer.config.settings.Plotting, export: pysewer.config.settings.Export)

Bases: object

preprocessing: Preprocessing

optimization: Optimization

plotting: Plotting

export: Export

pysewer.config.settings.load_config(custom_path: str | None = None, custom_setting_dict: dict | None = None) → Config

Load configuration with optional overrides.

pysewer.config.settings.config_to_dataframe(config: Config) → DataFrame

pysewer.config.settings.view_default_settings()

Preprocessing settings

class pysewer.config.settings.Preprocessing(dem_file_path: str | None = None, roads_input_data: str | GeoDataFrame | None = None, buildings_input_data: str | GeoDataFrame | None = None, dx: int = 10, pump_penalty: int = 1000, max_connection_length: int = 30, clustering: str = 'none', connect_buildings: bool = True, field_get_sinks: str = 'type', field_get_buildings: str = 'type', value_get_sinks: str = 'sink', value_get_buildings: str = 'building', add_private_sewer: bool = True, combined_sewer_factor: float = 1.0)

Bases: object

Preprocessing settings.

dem_file_path: str | None = None

roads_input_data: str | GeoDataFrame | None = None

buildings_input_data: str | GeoDataFrame | None = None

dx: int = 10

pump_penalty: int = 1000

max_connection_length: int = 30

clustering: str = 'none'

connect_buildings: bool = True

field_get_sinks: str = 'type'

field_get_buildings: str = 'type'

value_get_sinks: str = 'sink'

value_get_buildings: str = 'building'

add_private_sewer: bool = True

combined_sewer_factor: float = 1.0

Optimization settings

class pysewer.config.settings.Optimization(inhabitants_dwelling_attribute_name: str, inhabitants_dwelling: int, daily_wastewater_person: float, peak_factor: float, min_slope: float, max_slope: float, tmax: float, tmin: float, inflow_trench_depth: float, min_trench_depth: float = 0.0, diameters: list[float] = <factory>, roughness: float = 0.013, pressurized_diameter: float = 0.2, min_cover: float = 0.25, min_pipe_length: float = 2.0, velocity_min: float = 0.7, velocity_max: float = 3.0, max_depth_ratio: float = 0.75)

Bases: object

inhabitants_dwelling_attribute_name: str

inhabitants_dwelling: int

daily_wastewater_person: float

peak_factor: float

min_slope: float

max_slope: float

tmax: float

tmin: float

inflow_trench_depth: float

min_trench_depth: float = 0.0

diameters: list[float]

roughness: float = 0.013

pressurized_diameter: float = 0.2

min_cover: float = 0.25

min_pipe_length: float = 2.0

velocity_min: float = 0.7

velocity_max: float = 3.0

max_depth_ratio: float = 0.75

Visualisation settings

class pysewer.config.settings.Plotting(plot_connection_graph: bool, plot_junction_graph: bool, plot_sink: bool, plot_sewer: bool, hillshade: bool, colormap: str, sewer_graph: networkx.classes.graph.Graph | None = None, info_table: dict | None = None)

Bases: object

plot_connection_graph: bool

plot_junction_graph: bool

plot_sink: bool

plot_sewer: bool

hillshade: bool

colormap: str

sewer_graph: Graph | None = None

info_table: dict | None = None

Export settings

class pysewer.config.settings.Export(file_format: str)

Bases: object

file_format: str