Skip to content

main_flow_data API Reference

geoloop.bin.Flowdatamain.main_flow_data

main_flow_data(config_path: str | Path)

Command-line entry point to calculate, plot and optionally save a time-profile of flow rate.

Parameters:

Name Type Description Default
config_path str or Path

Path to a JSON config file.

required
Notes

This function: • Loads a FlowData configuration file • Builds a FlowData instance • Computes 1 year of hourly flow data • Plots instantaneous and cumulative flow • Saves the plot in the configured output directory