Multi-vector-simulator

Added
- Create function `utils.copy_inputs_template` to copy input_template from package data_files (608)
- Create `MANIFEST.in` file (608)
- Add entrypoint for `mvs_create_input_template` in `setup.py` (608)
- Create script `prepare_package.py` to add data to package and build dist folder (608)
- Five new KPI's added to E3: Onsite energy fraction, Onsite energy matching, Degree of autonomy, total_feedin_electricity_equivalent and internal generation (624)
- Add definition of `renewable share of local generation` in RTD, `E3.add_renewable_share_of_local_generation` and pytests (637)
- Add calculation of electricity equivalents in `E3.weighting_for_sector_coupled_kpi()` (637)
- Add benchmark test for the calculation of: `TOTAL_NON_RENEWABLE_GENERATION_IN_LES`, `TOTAL_RENEWABLE_GENERATION_IN_LES`, `TOTAL_NON_RENEWABLE_ENERGY_USE`, `TOTAL_RENEWABLE_ENERGY_USE`, `RENEWABLE_FACTOR`, `RENEWABLE_SHARE_OF_LOCAL_GENERATION` for one sector (637)
- New constant variable: `DATA="data"` (651)

Changed
- Moved `get_nested_value`, `set_nested_value`, `split_nested_path` from `tests/test_sensitivity.py` to `src/multi_vector_simulator/utils/__init__.py` (650)
- Rename PACKAGE_PATH to PACKAGE_DATA_PATH (608)
- Update release protocol within `Contributing.md` (608)
- Definition of renewable share (RES), now renewable factor (637)
- Refactoring of `RENEWABLE_SHARE` into `RENEWABLE_FACTOR` and some functions in E3 (now `E3.add_total_renewable_and_non_renewable_energy_origin` and `E3.add_renewable_factor`) (637)
- Rename: `Minimal renewable share constraint` to `Minimal renewable factor constraint` in all files (python, messages, RTD, json, tests, csv), so that this is in line with the definition and does not cause any confusion, explained in RTD (637)
- Modify `B0_data_input_json.py` to read "input_timeseries" into `pandas.Series` from epa formated input json (651)
- Modify `convert_mvs_params_to_epa` in `utils.data_parser` to convert `pandas.Series` back to "input_timeseries" (651)

Removed
- Variable `TEMPLATE_INPUT_PATH` (608)
- Field `data_files` from `setup.py` (608)

Fixed
- Calculation of the renewable share relative taking into account energy carrier weighting (637)

Added
- `E-Land_Requirements.rst`: Official E-Land requirement list as well as progress on functional and non-functional requirements (590)
- Add pytests for `E4.detect_excessive_excess_generation_in_bus()` (591)
- Add pypi release to release protocol and update/simplify protocol (601)
- Remove REPORT_PATH constant (607)
- Add report assets and example simulation to package_data in `setup.py` (607)
- Add a util function `copy_report_assets` to copy report asset to simulation output folder when user generates the report (607)
- Add entrypoints for `mvs_tool` and `mvs_report` in `setup.py` (this can be simply typed directly in terminal) (607)
- Updated readthedocs: Validation plan - Implemented tests and possible future ones (593)
- Updated readthedocs: Gather the MVS parameters in a csv file and parse it to a sphinx RTD file (620)
- Added more energy carriers and their weights to the list of already available energy carriers in constants.py (621)
- Three new KPI's added to MVS_output.rst read the docs page: Onsite energy fraction, Onsite energy matching, Degree of autonomy (609)
- New constant variables: `LOGS = "logs"`, `WARNINGS = "warnings"`, `ERRORS = "errors"` (623)
- Tests for `D1.transformer()` (596)
- Add economic model equations in readthedocs (581)
- Add component model equations and energy balance adapted to sector coupled example (581)
- Create function `F0.select_essential_results` to select main results out of `dict_values` (625)
- Create mapping between EPA and MVS parameter names (625)
- Create parameter parser from EPA to MVS (625)
- Create parameter parser from MVS to EPA (625)

Changed
- Order of readthedocs content (590)
- Make sure report can be generated even if figures are missing from simulation outputs (607)
- Move the code located in `mvs_report.py` into `multi_vector_simulator.cli:report` (607)
- Update installation steps in README and in RTD (607)
- If default folder does not exist when code is executed, example simulation's inputs are used from package_data (607)
- Rename `PATH_SIM_OUTPUT` to `ARG_PATH_SIM_OUTPUT` (607)
- Rename function `A0.create_parser` to `A0.mvs_arg_parser` (607)
- Update validation plan description in RTD (593)
- Column headers of csv input files need to be unique amongst all files, info added to documentation (602)
- Change mvs_eland to multi_vector_simulator in `docs/Code.rst` (620)
- Change mvs_eland to multi-vector-simulator in `docs/*.rst` `urls (620)
- Improved the description of assigning weightage to energy carriers in readthedocs (619)
- Replaced the DSO sub-system image in Modelling Assumptions chapter of readthedocs (622)
- Fixed several typos in readthedocs (622)
- Move the function parse_log_messages to F0 and modify it to print log messages in results JSON file (623)
- Move the function `parse_log_messages` from F1 to F0 and modify it to print log messages in results JSON file (623)
- If `assets` folder is not found in package look in current folder for `report/assets` folder (632)
- `D1.transformer_constant_efficiency_fix()` and `D1.transformer_constant_efficiency_optimize()`, as well as their tests to reassign attributes (596)
- Move `retrieve_date_time_info` from C0 to B0 (625)
- Conversion from dict to json drop the timeindexes from pandas.Series (625)
- Conversion from json to dict allow to load a timeindex for pandas.Series (625)
- Replace `==` by `is` in expression with `True`, `False` or `None` (625)
- Remove unused `dict_values` argument of function `receive_timeseries_from_csv` (625)
- Move the end of the function `receive_timeseries_from_csv` into `C0.compute_timeseries_properties()` (625)
- Fix rendering issues with the PDF report and web app: Tables, ES graph sizing (643)
- Improve the description of demands in the autoreport: Adapted section so that it applies to all vectors (647)

Removed
- Parameter label from input csv files; label is now set by filenames (for `project_data`, `economic_data`, `simulation_settings`) and column headers (for `energyConsumption`, `energyConversion`, `energyProduction`, `energyProviders`), special for storage: `filename` + `column header` (602)
- Remove reference to git branch ID in the report (607)

Fixed
- RTD entry for defining parameters as timeseries (597)
- Math equations of RTD in files `Model_Assumptions.rst` and `MVS_Output.rst` (604)
- Repaired the broken links to input CSV files (618)
- Outdated RTD info and mistakenly deleted sentence (629)
- All `variable_costs`, `efficiency` and `nominal_value` of transformers on output flows. Before they were inconsistently assigned to input or output flows. (596)
- Calculation of the renewable share relative taking into account energy carrier weighting (637)

Added
- Instruction to install graphviz on windows in `docs/troubleshooting.rst` (572)
- Benchmark test `test_benchmark_feature_parameters_as_timeseries` to ensure that parameters can always also be defined as a timeseries. Applied to `efficiency` of an energyConversion asset and `electricity_price` of an energyProduction asset (542)
- Input files for benchmark tests `test_benchmark_feature_input_flows_as_list` (`Feature_input_flows_as_list`) and `test_benchmark_feature_output_flows_as_list` (`Feature_output_flows_as_list`), but not the benchmark assertions (542)
- Error message if time series of non-dispatchable sources do not meet requirement: values betw. 0 and 1. (498)
- Requirement for time series of non-dispatchable sources in readthedocs (498)
- Provide a warning in case of excessive excess generation (498)
- Pytests for `C0.add_maximum_cap()`, renamed function into `C0.process_maximum_cap_constraint()` (498)
- Description of the inherited MVS limitations as well as the ones that can be addressed (580)

Changed
- Modify `setup.py` to upload the code as package on pypi.org (570)
- Improve message when the `tests/test_input_folder_parameters.py` fails (578)
- Modify PR template to precise to add assert message and link to example docstring
- Update CONTRIBUTING to add a "Write test for your code" section before the "Run tests locally" one (579)
- Modified readthedocs page describing the parameters of MVS (479)
- Changed `E2.calculate_dispatch_expenditures()` so that it can process parameters defined as lists (542)
- Rename `E4` to `E4_verification.py` (498)
- Rename package name `mvs_eland` to `multi-vector-simulator` in `setup.py` (587)
- Rename `src/mvs_eland` to `src/multi_vector_simulator` (587)
- Rename repository from `mvs_eland` to `multi-vector-simulator` (587)
- Refactor modules calls (`mvs_eland.` is replaced by `multi_vector_simulator.`) (587)
- Update `README.md` and `CONTRIBUTING.md` replacing `mvs_eland` or `mvs-eland` by `multi-vector-simulator` (587)

Removed
- Remove unused function `mvs_eland.utils.get_version_info` (587)

Fixed
- Update the release protocol in `CONTRIBUTING.md` file (576)
- Fix reading timeseries for parameters in `C0` (542)
- Constraint for `optimizedAddCap` of non-dispatchable sources: multiply `maximumCap` by `max(timeseries(kWh/kWp))` to fix issue 446 (562, 498)
-`timeseries_normalized` are calculated for all `timeseries` of non-dispatchable sources now (before only if `optimizeCap==True`) (562, 498)
- Input files of benchmark test `Test_Constraints.test_benchmark_minimal_renewable_share_constraint()` (498)

Added
- Evaluation of excess energy for each of the energy carriers and for the whole system. The excess per sector and their energy equivalent may currently be faulty (comp. issue 559) (555)
- Debug messages for pytests: `C0`, `D2` (555, 560)
- Labels on capacity barplot bars (567)

Changed
- `C1.total_demand_each_sector()` to `C1.total_demand_and_excess_each_sector()`, now also evaluating the excess energy flows (555)
- `energyBusses` now is defined by: `LABEL, ASSET_LIST, ENERGY_VECTOR`, all functions using `energyBusses` now follow this nomenclature (555)
- Energy excess sinks now also have parameter `ENERGY_VECTOR` (555)
- `C0.define_sink` now always defines a sink that is capacity-optimized (555)
- `D1.sink_dispatchable()`, renamed to `D1.sink_dispatchable_optimize()` now adds a capacity-optimized, dispatchable sink. (555)
- Simulation data `tests/inputs`: Oemof-solph results are not stored (555)
- Change logging level of some messages from `logging.info` to `logging.debug` (555)
- Move and rename json input files for D0 and D1 tests (`test_data_for_D0.json` to `tests/test_data/inputs_for_D0/mvs_config.json`, `test_data_for_D1.json` to `tests/test_data/inputs_for_D1/mvs_config.json`), add required parameters (555)
- Change requirements/test.txt: `black==19.10b0`, as otherwise there are incompatabilities (555)
- `D2.prepare_constraint_minimal_renewable_share`, including logging messages and pytest (560)
- Change the import path of the modules for automatic docstrings import in `docs/Code.rst` (564)
- Fix the docstrings with math expressions (need to add `r` before the `"""` of the docstring
) (564)
- Rename the function in F1 module `plot_flows` to `plot_instant_power` (567)
- Change flow to power in the instanteous power figures (567)
- `F1.plot_piecharts_of_costs()` now cites costs with currect currency and avoids decimal numbers (561)

Fixed
- `C1.check_feedin_tariff()` now also accepts `isinstance(diff, int)` (552)
- Feed-in sinks of the DSOs now are capacity-optimized and can actually be used (555)
- Incorrectly applied minimal renewable share criterion (560)
- Pdf report generation (566)
- Update fresh install instructions for developers (565)
- Graphs of the report now use appropriate currency (561)

Added
- Docstrings for E2 (520)
- New constant variable: `SIMULATION_RESULTS="simulation_results"` (520)
- Explicit calculation of replacement costs (`C2.get_replacement_costs()`), so that they can be used in `E2` for installed capacities and optimal additional capacities (520)
- New constant variable: JSON_WITH_RESULTS="json_with_results.json" (520)
- Benchmark test "Economic_KPI_C2_E2" to test economic evaluations in C2 and E2 (520)
- Possibility to add an upper bound on the number of days to display in a timeseries' plot (526)
- Graph of the energy system model to the report (528)
- Function to encode images into dash app's layout (528)
- System KPI now printed in automatic report (section "Energy system key performance indicators"), draft (525)
- Added units to system-wide cost KPI in excel and in report. Some of these changes might need to be reworked when elaborating on units for the report (525)
- `References.rst` to the readthedocs, which should gather all the references of the MVS (525)
- New system-wide KPI:
- Demand per energy carrier, in original unit and electricity equivalent with `E3.total_demand_each_sector()` (525)
- Attributed cost per energy carrier, related to the its share in the total demand equivalent with `E3.total_demand_each_sector()` (525)
- LCOE per energy carrier `E3.add_levelized_cost_of_energy_carriers()` (525)
- Default values for energy carrier "Heat" for `DEFAULT_WEIGHTS_ENERGY_CARRIERS` with `{UNIT: "KWh_eleq/kWh_therm", VALUE: 1}`. This is still TBD, as there is no source for this ratio yet (525)
- Default unit for energy carriers defined in `DEFAULT_WEIGHTS_ENERGY_CARRIERS`: ENERGY_CARRIER_UNIT. Might be used to define the units of flows and LCOE. (525)
- New constant variables: TIMESERIES_TOTAL, TIMESERIES_AVERAGE, LOGFILE, RENEWABLE_SHARE, TOTAL_DEMAND, SUFFIX_ELECTRICITY_EQUIVALENT, ATTRIBUTED_COSTS, LCOeleq, DEGREE_OF_SECTOR_COUPLING (525)
- New constant variable: OEMOF_BUSSES, MINIMAL_RENEWABLE_SHARE, CONSTRAINTS (538)
- New required input csv: `constraints.csv` including possible constraints for the energy system. Added to all input folders. (538)
- Added error message: New energy carriers always have to be added to `DEFAULT_WEIGHTS_ENERGY_CARRIERS` (`C0.check_if_energy_carrier_is_defined_in_DEFAULT_WEIGHTS_ENERGY_CARRIERS()`, applied to `ENERGY_VECTOR` and to fuel sources) (538)
- Added minimal renewable share contraint though `D2.constraint_minimal_renewable_share()` and added description of the constraint in `Model_Assumptions.rst` (538)
- Benchmark test for minimal renewable share constraint (538)
- Benchmark test `test_benchmark_AFG_grid_heatpump_heat` for a sector-coupled energy system, including electricity and heat, with a heat pump and an energy price as time series (524)
- Benchmark test descriptions for `test_benchmark_simple_scenarios.py` (524)
- Create `src/mvs_eland/utils` subpackage (contains `constants.py`, `constants_json_string.py
`, `constants_output.py` (501)

Changed
- Changed structure for `E2.get_cost()` and complete disaggregation of the formulas used in it (520)
- Added pytest for many `E2` functions (520)
- Changed and added pytests in for `C2` (520)
- All energyProviders that have key `FILENAME` (and, therefore, a timeseries), are now of `DISPATCHABILITY = False`(520)
- Changed structure of `E2.lcoe_assets()` so that each asset has a defined LCOE_ASSET. If `sum(FLOW)==0` of an asset, the LCOE_ASSET (utilization LCOE) is defined to be 0 (520)
- Color lists for plots are provided by user and are not hard coded anymore (527)
- Replace function `F1.draw_graph` by the class `F1.ESGraphRenderer` and use `graphviz` instead of
`networkx` to draw the graph of the energy system model (528)
- Rename variable `PLOTS_NX` to `PLOTS_ES` (528)
- Changed `requirements.txt` (removing and updating dependencies) (528)
- A png of the energy system model graph is only saved if either `-png` or `-pdf` options are chosen (530)
- Accepting string "TRUE"/"FALSE" now for boolean parameters (534)
- Order of pages in the readthedocs.io (525)
- Reactivated KPI: Renewable share. Updated pytests (525)
- Extended `DEFAULT_WEIGHTS_ENERGY_CARRIERS` by `Diesel` and `Gas`, added explaination in `Model_Assumptions.rs` (538)
- Create `dict_model` with constant variables in `D0` and update in `D1` (538)
- Separate the installation of the packages needed for the report generation from the mvs
simulation (501)
- Move all source files in `src/mvs_eland` (501)
- Move the content of the previous `src/utils.py` module to `src/mvs_eland/utils/__init__.py` (501)
- Rename `tests/constants.py` --> `tests/_constants.py` (501)
- Refactor modules calls (mostly `src.` is replaced by `mvs_eland.`) (501)
- Move `mvs_eland_tool` folder's content in `src/mvs_eland` (501)
- Gather all requirements files in a `requirements` folder and read the requirement from there for `setup.py` (501)
- Update `install_requires` and `extra_requires` in `setup.py` (501)

Removed
- `E2.add_costs_and_total`() (520)
- Calculation of energy expenditures using `price` (520)
- Function `F1.plot_input_timeseries` which is based on `matplotlib` (527)
- Dependency to `matplotlib` (528)
- Remove `STORE_NX_GRAPH` and `DISPLAY_NX_GRAPH` variables (530)
- Remove `tests/__init__.py` (501)
- Delete `mvs_eland_tool` folder (501)

Fixed
- Calculation of `cost_upfront` required a multiplication (520)
- Fixed `E2.convert_components_to_dataframe()`, Key error (520)
- Fixed `F1.extract_plot_data_and_title()`, Key error (520)
- Fixed hard-coded energy vector of ENERGY_PRODUCTION units in E1.convert_components_to_dataframe(520)
- Generating report for multiple sectors (534)
- Fixed hard-coded energy vector of `ENERGY_PRODUCTION` units in `E1.convert_components_to_dataframe` (520)
- Fixed parsing issue in `A1.conversion()`, incl. pytest (538)
- Quick fix to read a timeseries for `"price"` in `C0.define_source()` (524)
- Fix `C1.check_feedin_tariff()`: Now also applyable to timeseries of feed-in tariff or electricity prices (524)
- Add a warning message if the timeseries of demands or resources are empty (543)
- Fix failing KPI test (due to newer pandas version) (501)

Added
- Also components that have no investment costs now have a value (of 0) for COST_INVESTMENT and COST_UPFRONT (493)
- Display error message when feed-in tariff > electricity price of any asset in 'energyProvider.csv'. (497)
- Added pie plots created using Plotly library to the auto-report (482)
- Added functions to `F2_autoreport.py` that save the images of plots generated using Plotly to `MVS_outputs` folder as `.png` (499)
- Inserted docstrings in the definitions of all the functions in `F2_autoreport.py` (505)
- Functions in F1 to create plotly static `.png` files (512)
- New argument for MVS execution: `-png` to store plotly graphs to file (512)
- Benchmark test for peak demand pricing for grid and battery case (510)
- Logging error message if a cell is left empty for a parameter in the csvs (see `A1`) (492)
- Logging error message if a bus connects less then three assets including the excess sink, as in that case the energy system model is likely to be incomplete (`C1.check_for_sufficient_assets_on_busses()`) (492)

Changed
- Move and rename json converter and parser to B0 module (464)
- Modified json converter to avoid stringifying special types such as pandas.Dataframes (464)
- Changed the font family used in the plots in F2_autoreport.py and changed the wording of some comments (496)
- Changed styling of plots, mainly how legends appear in the PDF report (482)
- Move and rename json converter and parser to B0 module (464)
- Modified json converter to avoid stringifying special types such as pandas.Dataframes (464)
- Changed the font family used in the plots in F2_autoreport.py and changed the wording of some comments (496)
- Replaced parameter strings by variables (500)
- Changed the font family used in the plots in F2_autoreport.py and changed the wording of some comments (496)
- Moved function `C0.determine_lifetime_price_dispatch()` to C2 with all its sub-functions. (495)
- Changed calculation of `LIFETIME_PRICE_DISPATCH` for lists and pd.Series (see dosctrings of `C2.get_lifetime_price_dispatch_list`, `C2.get_lifetime_price_dispatch_timeseries`) (495)
- Changed dostring format in `C2` to numpy (495)
- Deactivated function `C2.fuel_price_present_value` as it is not used and TBD (495)
- Modified the doc-strings in the definitions of some functions to abide by the formatting rules of numpy doc-strings (505)
- Suppressed the log messages of the Flask server (for report webapp) (509)
- Move bulk data preparation code for report from F2 into E1 and F1 modules and into functions (511, 512)
- F2 now calls functions from F1 to prepare the figures of the report (512)
- Dispatchable (fuel) sources can now be defined by adding a column to the `energyProduction.csv` and setting `file_name==None` (492)
- Updated `Model_Assumptions.rst`: Minimal description of dispatchable fuel sources (492)
- `tests/inputs` energyAssets are updated (492)
- Fixed test_benchmark_AD_grid_diesel() - now this one tests fuel source and diesel at once (492)

Removed
- Functions to generate plots with matplotlib in F1 (512)
- Many tests that checked if matplot lib plots were stored to file, not replaced by new tests for storing plotly graphs to file (512)

Fixed
- Image path for readthedocs (Model_Assumpation.rst) (492)