Skip to content

Commit

Permalink
add documentation for extended_output_plots
Browse files Browse the repository at this point in the history
  • Loading branch information
stefan.schirmeister committed Sep 18, 2024
1 parent db3e3f9 commit 7ea1a5f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/source/simba_features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,10 @@ Generate report

The generation of the report is implemented as a mode, that can be activated with the keyword "report" in modes (:ref:`report`). The report generates most of the output files. The report can be called any number of times e.g. mode = ["sim", "report", "neg_depb_to_oppb", "report", "service_optimization", "report"]. For each report, a sub-folder is created in the output directory (as defined in the :ref:`config`) named "report_[nr]" with the respective number.

The generation of the report can be modified using the flag "cost_calculation" in :ref:`config`. If this flag is set to true, each report will also generate the file "summary_vehicles_costs.csv".
The generation of the report can be modified using flags in :ref:`config`.

1. If ``cost_calculation`` is set, each report will also generate the file "summary_vehicles_costs.csv".
2. If ``extended_output_plots`` is set, more plots will be saved to "extended_plots" in the report directory. These plots include the number of active rotations over time, a distribution of charge types, histograms of rotation consumption and distance as well as station-specific power levels.

Default outputs
###############
Expand Down
4 changes: 4 additions & 0 deletions docs/source/simulation_parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@ The example (data/simba.cfg) contains parameter descriptions which are explained
- false
- Boolean
- If activated, plots are displayed with every run of :ref:`report` mode
* - extended_output_plots
- false
- Boolean
- If set, create additional plots when running :ref:`report` mode
* - strategy_deps
- balanced
- SpiceEV Strategies (greedy, balanced, peak_shaving, peak_load_windows, balanced_market)
Expand Down

0 comments on commit 7ea1a5f

Please sign in to comment.