def test_if_f_opt_preexisting_path_output_folder_should_be_replaced(self, m_args):
if os.path.exists(self.test_out_path) is False:
os.mkdir(self.test_out_path)
some_file = os.path.join(self.test_out_path, "a_file.txt")
with open(some_file, "w") as of:
of.write("something")
A0.process_user_arguments()
assert os.path.exists(some_file) is False
def test_if_json_opt_and_more_than_one_json_file_in_input_folder_raise_fileexists_error(
self, m_args):
# create a folder with two json files
os.mkdir(self.fake_input_path)
with open(os.path.join(self.fake_input_path, JSON_FNAME), "w") as of:
of.write("something")
with open(os.path.join(self.fake_input_path, "file2.json"), "w") as of:
of.write("something")
with pytest.raises(FileExistsError):
A0.process_user_arguments()
def test_load_json_copies_json_file_to_output_folder(self, m_args):
A0.process_user_arguments()
A1.create_input_json(input_directory=CSV_PATH, pass_back=True)
dict_values = B0.load_json(JSON_CSV_PATH,
path_output_folder=self.test_out_path,
move_copy=True)
assert (os.path.exists(
os.path.join(
dict_values[SIMULATION_SETTINGS][PATH_OUTPUT_FOLDER_INPUTS],
CSV_FNAME,
)) is True)
def setup_module(m_args):
"""Run the simulation up to module E0 and save dict_values before and after evaluation"""
if os.path.exists(TEST_OUTPUT_PATH):
shutil.rmtree(TEST_OUTPUT_PATH, ignore_errors=True)
user_input = A0.process_user_arguments()
logging.debug("Accessing script: B0_data_input_json")
dict_values = B0.load_json(
user_input[PATH_INPUT_FILE],
path_input_folder=user_input[PATH_INPUT_FOLDER],
path_output_folder=user_input[PATH_OUTPUT_FOLDER],
move_copy=False,
)
logging.debug("Accessing script: C0_data_processing")
C0.all(dict_values)
logging.debug("Accessing script: D0_modelling_and_optimization")
results_meta, results_main = D0.run_oemof(dict_values)
with open(DICT_BEFORE, "wb") as handle:
pickle.dump(dict_values, handle, protocol=pickle.HIGHEST_PROTOCOL)
logging.debug("Accessing script: E0_evaluation")
E0.evaluate_dict(dict_values, results_main, results_meta)
with open(DICT_AFTER, "wb") as handle:
pickle.dump(dict_values, handle, protocol=pickle.HIGHEST_PROTOCOL)
def setup_class(m_args):
"""Run the simulation up to module E0 and prepare bus_data for E1"""
if os.path.exists(TEST_OUTPUT_PATH):
shutil.rmtree(TEST_OUTPUT_PATH, ignore_errors=True)
logging.debug("Accessing script: A0_initialization")
user_input = A0.process_user_arguments()
A1.create_input_json(input_directory=os.path.join(
user_input[PATH_INPUT_FOLDER], CSV_ELEMENTS))
logging.debug("Accessing script: B0_data_input_json")
dict_values = B0.load_json(
user_input[PATH_INPUT_FILE],
path_input_folder=user_input[PATH_INPUT_FOLDER],
path_output_folder=user_input[PATH_OUTPUT_FOLDER],
move_copy=True,
set_default_values=True,
)
logging.debug("Accessing script: C0_data_processing")
C0.all(dict_values)
logging.debug("Accessing script: D0_modelling_and_optimization")
results_meta, results_main = D0.run_oemof(dict_values)
bus_data = {}
# Store all information related to busses in bus_data
for bus in dict_values[ENERGY_BUSSES]:
# Read all energy flows from busses
bus_data.update({bus: solph.views.node(results_main, bus)})
# Pickle dump bus data
with open(BUS_DATA_DUMP, "wb") as handle:
pickle.dump(bus_data, handle, protocol=pickle.HIGHEST_PROTOCOL)
def test_if_csv_opt_path_input_file_set_to_path_input_folder_mvs_csv_config_dot_json(
self, m_args, tmpdir):
"""Check that the path_input_file is <path_input_folder>/mvs_csv_config.json """
os.mkdir(self.fake_input_path)
os.mkdir(os.path.join(self.fake_input_path, CSV_ELEMENTS))
user_inputs = A0.process_user_arguments()
assert user_inputs[PATH_INPUT_FILE] == os.path.join(
self.fake_input_path, CSV_ELEMENTS, CSV_FNAME)
def test_load_json_removes_json_file_from_inputs_folder(self, m_args):
A0.process_user_arguments()
A1.create_input_json(input_directory=CSV_PATH, pass_back=True)
dict_values = B0.load_json(JSON_CSV_PATH,
path_output_folder=self.test_out_path,
move_copy=True)
assert os.path.exists(os.path.join(
CSV_PATH,
CSV_ELEMENTS,
CSV_FNAME,
)) is False
assert os.path.exists(os.path.join(
CSV_PATH,
CSV_FNAME,
)) is False
def run_parts(margs):
if os.path.exists(TEST_OUTPUT_PATH):
shutil.rmtree(TEST_OUTPUT_PATH, ignore_errors=True)
user_input = A0.process_user_arguments()
logging.debug("Accessing script: B0_data_input_json")
dict_values = B0.load_json(
user_input[PATH_INPUT_FILE],
path_input_folder=user_input[PATH_INPUT_FOLDER],
path_output_folder=user_input[PATH_OUTPUT_FOLDER],
move_copy=False,
)
logging.debug("Accessing script: C0_data_processing")
C0.all(dict_values)
logging.debug("Run parts of D0_modelling_and_optimization")
model, dict_model = D0.model_building.initialize(dict_values)
model = D0.model_building.adding_assets_to_energysystem_model(
dict_values, dict_model, model)
return dict_values, model, dict_model
def test_input_folder_is_copied_in_output_within_folder_named_input(
self, m_args):
A0.process_user_arguments()
assert os.path.exists(os.path.join(self.test_out_path, INPUTS_COPY))
def test_if_log_opt_display_output_is_set_with_correct_value(self, m_args):
A0.process_user_arguments()
# TODO check the logging level
assert 1
def main(**kwargs):
r"""
Starts MVS tool simulations.
Other Parameters
----------------
overwrite : bool, optional
Determines whether to replace existing results in `path_output_folder`
with the results of the current simulation (True) or not (False).
Default: False.
pdf_report: bool, optional
Can generate an automatic pdf report of the simulation's results (True) or not (False)
Default: False.
input_type : str, optional
Defines whether the input is taken from the `mvs_config.json` file
("json") or from csv files ('csv') located within
<path_input_folder>/csv_elements/. Default: 'json'.
path_input_folder : str, optional
The path to the directory where the input CSVs/JSON files are located.
Default: 'inputs/'.
path_output_folder : str, optional
The path to the directory where the results of the simulation such as
the plots, time series, results JSON files are saved by MVS E-Lands.
Default: 'MVS_outputs/'
display_output : str, optional
Sets the level of displayed logging messages.
Options: "debug", "info", "warning", "error". Default: "info".
lp_file_output : bool, optional
Specifies whether linear equation system generated is saved as lp file.
Default: False.
"""
welcome_text = (
"\n \n Multi-Vector Simulation Tool (MVS) V" + version_num + " " +
"\n Version: " + version_date + " " +
'\n Part of the toolbox of H2020 project "E-LAND", ' +
"Integrated multi-vector management system for Energy isLANDs" +
"\n Coded at: Reiner Lemoine Institute (Berlin) " +
"\n Contributors: Martha M. Hoffmann \n \n ")
logging.debug("Accessing script: A0_initialization")
user_input = A0.process_user_arguments(welcome_text=welcome_text, **kwargs)
# Read all inputs
# print("")
# # todo: is user input completely used?
# dict_values = data_input.load_json(user_input[PATH_INPUT_FILE ])
move_copy_config_file = False
if user_input[INPUT_TYPE] == CSV_EXT:
logging.debug("Accessing script: A1_csv_to_json")
move_copy_config_file = True
A1.create_input_json(input_directory=os.path.join(
user_input[PATH_INPUT_FOLDER], CSV_ELEMENTS))
logging.debug("Accessing script: B0_data_input_json")
dict_values = B0.load_json(
user_input[PATH_INPUT_FILE],
path_input_folder=user_input[PATH_INPUT_FOLDER],
path_output_folder=user_input[PATH_OUTPUT_FOLDER],
move_copy=move_copy_config_file,
set_default_values=True,
)
F0.store_as_json(
dict_values,
dict_values[SIMULATION_SETTINGS][PATH_OUTPUT_FOLDER_INPUTS],
MVS_CONFIG,
)
print("")
logging.debug("Accessing script: C0_data_processing")
C0.all(dict_values)
F0.store_as_json(
dict_values,
dict_values[SIMULATION_SETTINGS][PATH_OUTPUT_FOLDER],
JSON_PROCESSED,
)
if "path_pdf_report" in user_input or "path_png_figs" in user_input:
save_energy_system_graph = True
else:
save_energy_system_graph = False
print("")
logging.debug("Accessing script: D0_modelling_and_optimization")
results_meta, results_main = D0.run_oemof(
dict_values,
save_energy_system_graph=save_energy_system_graph,
)
print("")
logging.debug("Accessing script: E0_evaluation")
E0.evaluate_dict(dict_values, results_main, results_meta)
logging.debug("Accessing script: F0_outputs")
F0.evaluate_dict(
dict_values,
path_pdf_report=user_input.get("path_pdf_report", None),
path_png_figs=user_input.get("path_png_figs", None),
)
return 1
def test_if_path_output_folder_exists_raise_fileexists_error(self, m_args):
"""The error message should advice the user to use -f option to force overwrite"""
if os.path.exists(self.test_out_path) is False:
os.mkdir(self.test_out_path)
with pytest.raises(FileExistsError):
A0.process_user_arguments()
def test_if_csv_opt_and_csv_elements_folder_not_in_input_folder_raise_filenotfound_error(
self, m_args, tmpdir):
with pytest.raises(FileNotFoundError):
A0.process_user_arguments(path_input_folder=tmpdir)
def test_if_json_opt_and_no_json_file_in_input_folder_raise_filenotfound_error(
self, m_args, tmpdir):
"""provide a temporary dir with no .json in it"""
with pytest.raises(FileNotFoundError):
A0.process_user_arguments(path_input_folder=tmpdir)
def test_if_path_output_folder_recursive_create_full_path(self, m_args):
A0.process_user_arguments()
assert os.path.exists(
os.path.join(self.test_out_path, "recursive_folder"))
def test_input_folder_not_existing_raise_filenotfound_error(self, m_args):
with pytest.raises(FileNotFoundError):
A0.process_user_arguments()
def test_if_pdf_opt_the_key_path_pdf_report_exists_in_user_inputs(
self, m_args):
user_inputs = A0.process_user_arguments()
assert user_inputs["path_pdf_report"] == os.path.join(
self.test_out_path, REPORT_FOLDER, PDF_REPORT)
assert "path_png_figs" not in user_inputs.keys()
def test_if_both_pdf_and_png_opt_raises_no_error(self, m_args):
user_inputs = A0.process_user_arguments()
assert "path_png_figs" in user_inputs.keys()
assert "path_pdf_report" in user_inputs.keys()
def test_if_png_pdf_not_active(self, m_args):
user_inputs = A0.process_user_arguments()
assert "path_png_figs" in user_inputs.keys()
assert "path_pdf_report" not in user_inputs.keys()
def test_if_no_pdf_opt_the_key_path_pdf_report_does_not_exist_in_user_inputs(
self, m_args):
user_inputs = A0.process_user_arguments()
assert "path_pdf_report" not in user_inputs.keys()
