Skip to content

Commit

Permalink
renaming
Browse files Browse the repository at this point in the history
  • Loading branch information
@k-rieck
k-rieck committed Jan 16, 2024
1 parent f3837ba commit a632df1
Show file tree
Hide file tree
Showing 9 changed files with 128 additions and 124 deletions.
10 changes: 5 additions & 5 deletions hisim/json_generator.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ class ConfigFile(JSONWizard):
component_entries: List[ComponentEntry] = field(default_factory=list)
my_simulation_parameters: Optional[SimulationParameters] = None
my_module_config: Optional[Dict[str, Any]] = None
pyam_data_information: Optional[Dict[str, Any]] = None
scenario_data_information: Optional[Dict[str, Any]] = None


class JsonConfigurationGenerator:
Expand All @@ -65,11 +65,11 @@ def set_module_config(self, my_module_config_path: str) -> None:
config_dict = json.load(openfile)
self.config_file.my_module_config = config_dict

def set_pyam_data_information_dict(
self, pyam_data_information_dict: Dict[str, Any]
def set_scenario_data_information_dict(
self, scenario_data_information_dict: Dict[str, Any]
) -> None:
"""Sets some pyam information concerning the data."""
self.config_file.pyam_data_information = pyam_data_information_dict
"""Sets some scenario information concerning the result data."""
self.config_file.scenario_data_information = scenario_data_information_dict

def add_component(self, config: Type[ConfigBase]) -> ComponentEntry:
"""Adds a component and returns a component entry."""
Expand Down
60 changes: 30 additions & 30 deletions hisim/postprocessing/postprocessing_main.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ def __init__(self):
self.dirname: str
self.chapter_counter: int = 1
self.figure_counter: int = 1
self.pyam_data_folder: str = ""
self.result_data_folder_for_scenario_evaluation: str = ""
self.model: str = "HiSim"
self.scenario: str = ""
self.region: str = ""
Expand Down Expand Up @@ -289,13 +289,13 @@ def run(self, ppdt: PostProcessingDataTransfer) -> None: # noqa: MC0001
+ f"{duration:1.2f}s."
)

# Write Outputs to pyam.IAMDataframe format for scenario evaluation
# Write Outputs to specific format for scenario evaluation (idea for format from pyam package)
if (
PostProcessingOptions.PREPARE_OUTPUTS_FOR_SCENARIO_EVALUATION_WITH_PYAM
PostProcessingOptions.PREPARE_OUTPUTS_FOR_SCENARIO_EVALUATION
in ppdt.post_processing_options
):
log.information("Prepare results for scenario evaluation with pyam.")
self.prepare_results_for_scenario_evaluation_with_pyam(ppdt)
log.information("Prepare results for scenario evaluation.")
self.prepare_results_for_scenario_evaluation(ppdt)

# Open file explorer
if (
Expand Down Expand Up @@ -755,20 +755,20 @@ def export_sankeys(self):
"""
pass # noqa: unnecessary-pass

def prepare_results_for_scenario_evaluation_with_pyam(
def prepare_results_for_scenario_evaluation(
self, ppdt: PostProcessingDataTransfer
) -> None:
"""Prepare the results for the scenario evaluation with pyam."""
"""Prepare the results for the scenario evaluation."""

# create pyam data foler
self.pyam_data_folder = os.path.join(
ppdt.simulation_parameters.result_directory, "pyam_data"
# create result data folder
self.result_data_folder_for_scenario_evaluation = os.path.join(
ppdt.simulation_parameters.result_directory, "result_data_for_scenario_evaluation"
)
if os.path.exists(self.pyam_data_folder) is False:
os.makedirs(self.pyam_data_folder)
if os.path.exists(self.result_data_folder_for_scenario_evaluation) is False:
os.makedirs(self.result_data_folder_for_scenario_evaluation)
else:
log.information(
"This pyam_data path exists already: " + self.pyam_data_folder
"This result data path exists already: " + self.result_data_folder_for_scenario_evaluation
)

# --------------------------------------------------------------------------------------------------------------------------------------------------------------
Expand All @@ -794,7 +794,7 @@ def prepare_results_for_scenario_evaluation_with_pyam(
"year": [],
"value": [],
}
# set pyam model name
# set model name
self.model = "".join(["HiSim_", ppdt.module_filename])

# set pyam scenario name
Expand All @@ -807,15 +807,15 @@ def prepare_results_for_scenario_evaluation_with_pyam(
else:
self.scenario = ""

# set pyam region
# set region
if SingletonSimRepository().exist_entry(key=SingletonDictKeyEnum.LOCATION):
self.region = SingletonSimRepository().get_entry(
key=SingletonDictKeyEnum.LOCATION
)
else:
self.region = ""

# set pyam year or timeseries
# set year or timeseries
self.year = ppdt.simulation_parameters.year
timeseries_hourly = ppdt.results_hourly.index
timeseries_daily = ppdt.results_daily.index
Expand All @@ -825,15 +825,15 @@ def prepare_results_for_scenario_evaluation_with_pyam(
PostProcessingOptions.COMPUTE_AND_WRITE_KPIS_TO_REPORT
in ppdt.post_processing_options
):
self.write_kpis_in_pyam_dict(
self.write_kpis_in_dict(
ppdt=ppdt, simple_dict_cumulative_data=simple_dict_hourly_data)
self.write_kpis_in_pyam_dict(
self.write_kpis_in_dict(
ppdt=ppdt, simple_dict_cumulative_data=simple_dict_daily_data
)
self.write_kpis_in_pyam_dict(
self.write_kpis_in_dict(
ppdt=ppdt, simple_dict_cumulative_data=simple_dict_monthly_data
)
self.write_kpis_in_pyam_dict(
self.write_kpis_in_dict(
ppdt=ppdt, simple_dict_cumulative_data=simple_dict_cumulative_data
)

Expand All @@ -846,7 +846,7 @@ def prepare_results_for_scenario_evaluation_with_pyam(
)
self.write_filename_and_save_to_csv(
dataframe=dataframe_hourly_data,
folder=self.pyam_data_folder,
folder=self.result_data_folder_for_scenario_evaluation,
module_filename=ppdt.module_filename,
simulation_duration=ppdt.simulation_parameters.duration.days,
simulation_year=ppdt.simulation_parameters.year,
Expand All @@ -861,7 +861,7 @@ def prepare_results_for_scenario_evaluation_with_pyam(
)
self.write_filename_and_save_to_csv(
dataframe=dataframe_daily_data,
folder=self.pyam_data_folder,
folder=self.result_data_folder_for_scenario_evaluation,
module_filename=ppdt.module_filename,
simulation_duration=ppdt.simulation_parameters.duration.days,
simulation_year=ppdt.simulation_parameters.year,
Expand All @@ -876,7 +876,7 @@ def prepare_results_for_scenario_evaluation_with_pyam(
)
self.write_filename_and_save_to_csv(
dataframe=dataframe_monthly_data,
folder=self.pyam_data_folder,
folder=self.result_data_folder_for_scenario_evaluation,
module_filename=ppdt.module_filename,
simulation_duration=ppdt.simulation_parameters.duration.days,
simulation_year=ppdt.simulation_parameters.year,
Expand Down Expand Up @@ -907,7 +907,7 @@ def prepare_results_for_scenario_evaluation_with_pyam(
simple_df_yearly_data = pd.DataFrame(simple_dict_cumulative_data)
self.write_filename_and_save_to_csv(
dataframe=simple_df_yearly_data,
folder=self.pyam_data_folder,
folder=self.result_data_folder_for_scenario_evaluation,
module_filename=ppdt.module_filename,
time_resolution_of_data="yearly",
simulation_duration=ppdt.simulation_parameters.duration.days,
Expand All @@ -916,7 +916,7 @@ def prepare_results_for_scenario_evaluation_with_pyam(
)

# --------------------------------------------------------------------------------------------------------------------------------------------------------------
# create dictionary with all import pyam information
# create dictionary with all import data information
data_information_dict = {
"model": self.model,
"scenario": self.scenario,
Expand All @@ -934,16 +934,16 @@ def prepare_results_for_scenario_evaluation_with_pyam(
json_generator_config.set_module_config(
my_module_config_path=ppdt.my_module_config_path
)
json_generator_config.set_pyam_data_information_dict(
pyam_data_information_dict=data_information_dict
json_generator_config.set_scenario_data_information_dict(
scenario_data_information_dict=data_information_dict
)
for component in ppdt.wrapped_components:
json_generator_config.add_component(config=component.my_component.config)

# save the json config
json_generator_config.save_to_json(
filename=os.path.join(
self.pyam_data_folder, "data_information_for_pyam.json"
self.result_data_folder_for_scenario_evaluation, "data_information_for_scenario_evaluation.json"
)
)

Expand All @@ -961,12 +961,12 @@ def write_component_configurations_to_json(
)
)

def write_kpis_in_pyam_dict(
def write_kpis_in_dict(
self,
ppdt: PostProcessingDataTransfer,
simple_dict_cumulative_data: Dict[str, Any],
) -> None:
"""Write kpis in pyam dictionary."""
"""Write kpis in dictionary."""

kpi_compute_return = compute_kpis(
components=ppdt.wrapped_components,
Expand Down
Loading

0 comments on commit a632df1

Please sign in to comment.