src.spyice.main_process#

class src.spyice.main_process.MainProcess[source]#

Bases: object

Main class to run the model.

Parameters:

  • config – The configuration object.

  • hyd_output_dir (Path | str) – The directory path for the hydraulic output. Defaults to the ‘outputs’ directory in the current working directory.

  • project_path (Path | str) – The project path. Defaults to the current working directory.

__init__(config, hyd_output_dir=WindowsPath('C:/Users/sneha/Documents/MBDHiWi/MBDHiwi/spyicedir/spyicedir/docs/outputs'), project_path='C:\\Users\\sneha\\Documents\\MBDHiWi\\MBDHiwi\\spyicedir\\spyicedir\\docs')[source]#
Parameters:

  • config (DictConfig) – The configuration object.

  • hyd_output_dir (Path | str) – The directory path for the hydraulic output. Defaults to the ‘outputs’ directory in the current working directory.

  • project_path (Path | str) – The project path. Defaults to the current working directory.

Return type:

None

plot_model(userinput_data, results_data, analysis_data)[source]#

Plots various visualizations of the model.

Parameters:

  • userinput_data (UserInputData) – The user input data.

  • results_data (ResultsData) – The results data.

  • analysis_data (AnalysisData) – The error analysis data.

Returns:

None

Raises:

None –

run_model()[source]#

Runs the model using the provided configuration and output directory.

Parameters:

None

Returns:

None

Return type:

None