Correct SimBEV spelling, add license #68

rl-institut · Sep 26, 2023 · dfaa651 · dfaa651
1 parent 1b268ee
commit dfaa651
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <img align="right" width="150" src="https://github.com/rl-institut/simbev/blob/master/docs/img/rli_logo.png">
 
-# simBEV
+# SimBEV
 
 Simulation of electric vehicle charging demand.
 

diff --git a/docs/source/simbev_intro.rst b/docs/source/simbev_intro.rst
@@ -6,4 +6,22 @@ charging demand of electric vehicles in different regions and scenarios. The key
 
 * Detailed modelling of driving profiles
 * Stepwise simulation without using perfect foresight
-* Calculating charging demand in a region split into 4 use cases
+* Calculating charging demand in a region split into 4 use cases
+
+License
+-------
+
+GNU Affero General Public License v3.0
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
diff --git a/docs/source/usage_details.rst b/docs/source/usage_details.rst
@@ -69,6 +69,30 @@ defaults to:
 
 - Results are created in the subdirectory `results` in the scenario directory
 
+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
+
 Iterations
 ----------