Open, validate, and run
Open an INP file, validate it, run the engine, and inspect the log.
View 01_open_validate_run.pyExamples Gallery
The repository includes simple teaching scripts, fuller standard examples, and generated API notebooks. Run scripts from the repository root so they can find examples/example.inp.
python examples/01_open_validate_run.py
python examples/standard/01_open_validate_run.py
jupyter notebook examples/11_all_get_functions.ipynbModify conduit diameters and compare
Clone and edit conduit geometry for scenario comparison.
View 02_modify_conduit_diameters_compare.pyStep-by-step runs
Use the step iterator to monitor simulation progress.
View 03_step_by_step_runs_dynamic_control.pyLayout plots
Render network maps with static and data-driven styles.
View 04_plot_layout_examples.pyTime-series plots
Plot node, link, and system result variables.
View 05_plot_timeseries_examples.pyProfile plots
Draw longitudinal paths with optional HGL overlays.
View 06_plot_profile_examples.pyGIS/CSV/Excel export
Export model and result tables to external formats.
View 07_export_examples.pyTime and count helpers
Use pre-run and post-run time vectors plus object counts.
View 08_time_and_count_functions.pyGet/set patterns
Inspect and edit parameters through the dotted API.
View 09_get_set_examples.pyBuild model from scratch
Create nodes, links, rainfall data, and subcatchments.
View 10_create_model_from_scratch_add_remove.pyAll get functions
Reference notebook generated from the package API surface.
Open notebookAll set functions
Reference notebook generated from the package API surface.
Open notebookAll add functions
Reference notebook generated from the package API surface.
Open notebookAll remove functions
Reference notebook generated from the package API surface.
Open notebookAll plot functions
Reference notebook generated from the package API surface.
Open notebookAll import/export functions
Reference notebook generated from the package API surface.
Open notebook