pymfm.scenario_forecast_kit package

Submodules

pymfm.scenario_forecast_kit.forecast_generation module

pymfm.scenario_forecast_kit.forecast_generation.calc_dynamic_factor(day_of_year)[source]

Calculate the dynamic factor for a given day of the year.

Parameters:

day_of_year – The day of the year (1-365).

Returns:

The dynamic factor.

pymfm.scenario_forecast_kit.forecast_generation.calc_load_scaling_factor(households, avg_consumption)[source]

Calculate the load scaling factor for a given number of households and average consumption.

Parameters:

  • households – The number of households.

  • avg_consumption – The average consumption in kWh per household.

Returns:

The load scaling factor.

pymfm.scenario_forecast_kit.forecast_generation.calc_total_load(slp_value, dynamic_factor, load_scaling_factor)[source]

Calculate the total load for a given SLP (Standard Load Profile) value, dynamic factor, and load scaling factor.

Parameters:

  • slp_value – The SLP value for a specific timestamp.

  • dynamic_factor – The dynamic factor for the day.

  • load_scaling_factor – The load scaling factor.

Returns:

The total dynamic load in kW.

pymfm.scenario_forecast_kit.forecast_generation.generate_forecast(input_folder_path, output_folder_path, time_resolution)[source]

Generate a forecast based on input JSON files and save the results in the output folder.

Parameters:

  • input_folder_path – Path to the folder containing input JSON files.

  • output_folder_path – Path to the folder where output JSON files will be saved.

  • time_resolution – Time resolution in minutes for the forecast.

Returns:

A list of forecast data for each input file.

pymfm.scenario_forecast_kit.scenario_generation module

pymfm.scenario_forecast_kit.scenario_generation.generate_scenario(forecast_input_file, scenario_input_file, output_file)[source]

Generate a scenario JSON file by merging information from two input JSON files.

Parameters:

  • forecast_input_file – Path to the forecast input JSON file.

  • scenario_input_file – Path to the scenario input JSON file.

  • output_file – Path to the output JSON file to save the merged scenario.

Returns:

None

Module contents