From 7ea1a5fd67065637f82ab3940619018cb3500490 Mon Sep 17 00:00:00 2001 From: "stefan.schirmeister" Date: Wed, 18 Sep 2024 16:57:42 +0200 Subject: [PATCH] add documentation for extended_output_plots --- docs/source/simba_features.rst | 5 ++++- docs/source/simulation_parameters.rst | 4 ++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/source/simba_features.rst b/docs/source/simba_features.rst index 914a9356..cc392797 100644 --- a/docs/source/simba_features.rst +++ b/docs/source/simba_features.rst @@ -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 ############### diff --git a/docs/source/simulation_parameters.rst b/docs/source/simulation_parameters.rst index cbfba443..3ce450fe 100644 --- a/docs/source/simulation_parameters.rst +++ b/docs/source/simulation_parameters.rst @@ -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)