From 134f76b16793baf726198f96f80ee4d6ede1d245 Mon Sep 17 00:00:00 2001 From: lilAndy-bruh Date: Wed, 20 Sep 2023 16:02:42 +0200 Subject: [PATCH] Add simbev_intro.rst, add simulation_settings.rst, correct writing of SimBEV #68 --- docs/source/getting_started.rst | 2 +- docs/source/index.rst | 12 +- docs/source/simbev_intro.rst | 9 ++ docs/source/simulation_settings.rst | 173 ++++++++++++++++++++++++++++ docs/source/usage_details.rst | 41 +------ 5 files changed, 189 insertions(+), 48 deletions(-) create mode 100644 docs/source/simbev_intro.rst create mode 100644 docs/source/simulation_settings.rst diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 93008d5..f07bd97 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -7,7 +7,7 @@ Getting started :local: :backlinks: top -Installing simBEV +Installing SimBEV ================= Install using pip diff --git a/docs/source/index.rst b/docs/source/index.rst index 830b9e6..1afd73e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,20 +6,12 @@ Welcome to SimBEV's documentation! ======================================== -What is SimBEV? ---------------- - -Simbev stands for "Simulation of Battery Electric Vehicles". Simbev uses german mobility data to calculate expected -charging demand of electric vehicles in different regions and scenarios. The key features of Simbev are: - -* Detailed modelling of driving profiles -* Stepwise simulation without using perfect foresight -* Calculating charging demand in a region split into 4 use cases - .. toctree:: :maxdepth: 2 :caption: Contents + simbev_intro getting_started usage_details + simulation_settings features diff --git a/docs/source/simbev_intro.rst b/docs/source/simbev_intro.rst new file mode 100644 index 0000000..16ed773 --- /dev/null +++ b/docs/source/simbev_intro.rst @@ -0,0 +1,9 @@ +What is SimBEV? +--------------- + +SimBEV stands for "Simulation of Battery Electric Vehicles". SimBEV uses german mobility data to calculate expected +charging demand of electric vehicles in different regions and scenarios. The key features of SimBEV are: + +* Detailed modelling of driving profiles +* Stepwise simulation without using perfect foresight +* Calculating charging demand in a region split into 4 use cases \ No newline at end of file diff --git a/docs/source/simulation_settings.rst b/docs/source/simulation_settings.rst new file mode 100644 index 0000000..0217453 --- /dev/null +++ b/docs/source/simulation_settings.rst @@ -0,0 +1,173 @@ +Simulation Settings +=================== + +Required Parameters for a minimal simulation +-------------------------------------------- + +Set parameters for your scenario +-------------------------------- + +Select regio-type for the mobility characteristics: + +Rural regions: + * Kleinstädtischer, dörflicher Raum - LR_Klein + * Mittelstädte, städtischer Raum - LR_Mitte + * Zentrale Stadt - LR_Zentr +Urban regions: + * Kleinstädtischer, städtischer Raum - SR_Klein + * Mittelstädte, städtischer Raum - SR_Mitte + * Regiopolen, Großstädte - SR_Gross + * Metropole - SR_Metro + +Change vehicle configuration + * battery capacity + * charging power (slow and fast) + * consumption + +Decide how many vehicles should be simulated: + +- note: more than 5000 vehicles of one type in one region is not necessary, if you want to analyze more, scale it accordingly + + +Additional Settings +------------------- + +... + +Basic Parameters +---------------- + ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| keyword | example | description | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| input_type | probability | choose what kind of input is used for driving profiles (Options: probability or profile) | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| input_directory | data/probability | specify where the input data is located | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| eta_cp | 1 | efficiency of charging points | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| stepsize | 15 | step size of simulation (should stay at 15 min, best results) | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| start_date | 2021-09-17 | start and end date of simulation in format YYY-MM-DD | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| end_date | 2021-09-30 | | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| soc_min | 0.2 | | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| charging_threshold | 0.8 | | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| distance_threshold_extra_urban | 50 | | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| consumption_factor_highway | 1.2 | | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| dc_power_threshold | 50 | | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| threshold_retail_limitation | 21 | | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| threshold_street_night_limitation | 21 | | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| maximum_park_time_flag | False | | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| maximum_park_time | 10 | | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| lower_maximum_park_time_street_night | 8 | | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| upper_maximum_park_time_street_night | 12 | | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| street_night_charging_flag | True | | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| home_night_charging_flag | False | | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| night_departure_standard_deviation | 1 | | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ +| night_departure_time | 9 | | ++--------------------------------------+------------------+------------------------------------------------------------------------------------------+ + +Output Parameters +----------------- + ++----------------------------------+---------+--------------------------------------------------------------------------+ +| keyword | example | description | ++----------------------------------+---------+--------------------------------------------------------------------------+ +| vehicle_csv | true | decide if you want a output csv-file for each car simulated | ++----------------------------------+---------+--------------------------------------------------------------------------+ +| rid_time_series_csv | true | ecide if you want a output csv-file for all cars per uc | ++----------------------------------+---------+--------------------------------------------------------------------------+ +| plot_grid_time_series_split | false | decide if you want a plot png-file for each region simulated | ++----------------------------------+---------+--------------------------------------------------------------------------+ +| plot_grid_time_series_collective | false | decide if you want a plot png-file for all regions simulated in one plot | ++----------------------------------+---------+--------------------------------------------------------------------------+ +| analyze | false | | ++----------------------------------+---------+--------------------------------------------------------------------------+ +| timing | false | | ++----------------------------------+---------+--------------------------------------------------------------------------+ + +Rampup_ev Parameters +-------------------- + +Number of every vehicle type per region. + ++---------+-------------------+-----------------------+ +| keyword | filename.datatype | description | ++---------+-------------------+-----------------------+ +| rampup | regions.csv | Organized in a matrix | ++---------+-------------------+-----------------------+ + + +Technical data Parameters +------------------------- + +Technical data for the electrical vehicles. + ++----------------+------------------------------+-------------+ +| keyword | filename.datatype | description | ++----------------+------------------------------+-------------+ +| tech_data | tech_data.csv | | ++----------------+------------------------------+-------------+ +| | tech_data_by_probability.csv | | ++----------------+------------------------------+-------------+ +| charging_curve | charging_curve.csv | | ++----------------+------------------------------+-------------+ +| hpc_data | hpc_config.csv | | ++----------------+------------------------------+-------------+ + +User Data Parameters +-------------------- + ++-------------+-------------------+-------------+ +| keyword | filename.datatype | description | ++-------------+-------------------+-------------+ +| user_groups | user_groups.csv | | ++-------------+-------------------+-------------+ + +Charging Probability Parameters +------------------------------- + ++-------------------+-------------------------------------+-------------------------------------------------------+ +| keyword | filename.datatype | description | ++-------------------+-------------------------------------+-------------------------------------------------------+ +| slow | harging_probability.csv | charging probabilities for all locations | ++-------------------+-------------------------------------+-------------------------------------------------------+ +| fast | fast_charging_probability.csv | | ++-------------------+-------------------------------------+-------------------------------------------------------+ +| use_case | charging_probability_by_usecase.csv | optional | ++-------------------+-------------------------------------+-------------------------------------------------------+ +| home_work_private | home_work_private.csv | share of private charging at home/work, 1 equals 100% | ++-------------------+-------------------------------------+-------------------------------------------------------+ +| energy_min | energy_min.csv | | ++-------------------+-------------------------------------+-------------------------------------------------------+ + +Simulation Parameters +--------------------- + ++------------------+---------+-------------+ +| keyword | example | description | ++------------------+---------+-------------+ +| scaling | 1 | | ++------------------+---------+-------------+ +| num_threads | 4 | | ++------------------+---------+-------------+ +| seed | 3 | | ++------------------+---------+-------------+ +| private_only_run | false | | ++------------------+---------+-------------+ diff --git a/docs/source/usage_details.rst b/docs/source/usage_details.rst index 193960d..9ae1646 100644 --- a/docs/source/usage_details.rst +++ b/docs/source/usage_details.rst @@ -6,7 +6,7 @@ This section gives a quick overview, what you can do with SimBEV and how to use General Concept --------------- -Simbev forecast charging demand for different e-cars for a pregiven time period. It does so by analysing the mobility in Germany +SimBEV forecast charging demand for different e-cars for a pre-given time period. It does so by analysing the mobility in Germany data. This data is split into different region types: Rural regions: @@ -22,9 +22,9 @@ Urban regions: The system is parameterized with the help of different input parameters such as battery capacity and charging power (slow and fast) as well as the consumption of each car. -- It reads the data and creates simBEV object(s) (depends on the specified iterations). +- It reads the data and creates SimBEV object(s) (depends on the specified iterations). -- Every simBEV object gets setup. +- Every SimBEV object gets setup. - For every region a new process is created and it iterates through all vehicles and generate their events and outputs. @@ -46,15 +46,6 @@ With SimBEV, you can: #. Application of different charging strategies with SpiceEV -Configuration possibilities ---------------------------- -Each simulation must include the following parameters: - -#. param1 -#. param2 - - - Get the data ------------ @@ -64,7 +55,7 @@ Create a scenario ----------------- - You can use a default scenario or define a custom one in the directory `scenarios` -- Run simbev with the desired scenario: +- Run SimBEV with the desired scenario: .. code:: bash @@ -93,27 +84,3 @@ or .. code:: bash python -m simbev --repeat - -Set parameters for your scenario --------------------------------- - -Select regio-type for the mobility characteristics: - -Rural regions: - * Kleinstädtischer, dörflicher Raum - LR_Klein - * Mittelstädte, städtischer Raum - LR_Mitte - * Zentrale Stadt - LR_Zentr -Urban regions: - * Kleinstädtischer, städtischer Raum - SR_Klein - * Mittelstädte, städtischer Raum - SR_Mitte - * Regiopolen, Großstädte - SR_Gross - * Metropole - SR_Metro - -Change vehicle configuration - * battery capacity - * charging power (slow and fast) - * consumption - -Decide how many vehicles should be simulated: - -- note: more than 5000 vehicles of one type in one region is not necessary, if you want to analyze more, scale it accordingly