deflex.create_scenario¶

deflex.create_scenario(path, file_type=None)[source]¶

Create a deflex scenario object from file.

Parameters:	path (str) – A valid deflex scenario file. file_type (str or None) – Type of the input data. Valid values are ‘csv’, ‘xlsx’, None. If the input is non the path should end on ‘csv’, ‘.xlsx’ to allow auto-detection.
Returns:
Return type:	deflex.DeflexScenario

Examples

>>> from deflex import fetch_test_files, TEST_PATH
>>> fn = fetch_test_files("de17_heat.xlsx")
>>> s = create_scenario(fn, file_type="xlsx")
>>> type(s)
<class 'deflex.scenario.DeflexScenario'>
>>> int(s.input_data["volatile plants"]["capacity"]["DE01", "wind"])
3815
>>> type(create_scenario(fn))
<class 'deflex.scenario.DeflexScenario'>
>>> create_scenario(fn, file_type="csv"
...     )  # doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
 ...
NotADirectoryError: [Errno 20] Not a directory: