Merge pull request #135 from rl-institut/release_prep

Release prep

.pylintrc

@@ -22,7 +22,7 @@ jobs=1
 
 # List of plugins (as comma separated values of python modules names) to load,
 # usually to register additional checkers.
-load-plugins=
+load-plugins=pylint.extensions.docparams
 
 # Pickle collected data for later comparisons.
 persistent=yes
@@ -54,43 +54,15 @@ confidence=
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
-disable=parameter-unpacking,
-        old-raise-syntax,
-        long-suffix,
-        old-ne-operator,
-        old-octal-literal,
-        non-ascii-bytes-literal,
+disable=consider-using-f-string,
         raw-checker-failed,
         bad-inline-option,
         locally-disabled,
-        locally-enabled,
         file-ignored,
         suppressed-message,
         useless-suppression,
         deprecated-pragma,
-        coerce-method,
-        no-absolute-import,
-        old-division,
-        dict-iter-method,
-        dict-view-method,
-        next-method-called,
-        metaclass-assignment,
-        reload-builtin,
-        oct-method,
-        hex-method,
-        nonzero-method,
-        cmp-method,
-        eq-without-hash,
-        div-method,
-        idiv-method,
-        rdiv-method,
-        exception-message-attribute,
-        invalid-str-codec,
-        sys-max-int,
-        bad-python3-import,
-        next-method-defined,
         no-member,
-        missing-docstring,
         invalid-name,
         redefined-builtin,
         too-many-arguments,
@@ -105,7 +77,8 @@ disable=parameter-unpacking,
         too-many-lines,
         too-many-instance-attributes,
         too-few-public-methods,
-        arguments-differ
+        arguments-differ,
+        unspecified-encoding
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -274,18 +247,11 @@ indent-after-paren=4
 indent-string='    '
 
 # Maximum number of characters on a single line.
-max-line-length=100
+max-line-length=120
 
 # Maximum number of lines in a module
 max-module-lines=1000
 
-# List of optional constructs for which whitespace checking is disabled. `dict-
-# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
-# `trailing-comma` allows a space between comma and closing bracket: (a, ).
-# `empty-line` allows space-only lines.
-no-space-check=trailing-comma,
-               dict-separator
-
 # Allow the body of a class to be on the same line as the declaration if body
 # contains single statement.
 single-line-class-stmt=no

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.
 

docs/Makefile

@@ -5,7 +5,7 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
+SOURCEDIR     = source
 BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".

docs/source/_static/style.css

@@ -0,0 +1,3 @@
+.wy-nav-content {
+    max-width: none;
+}

docs/source/conf.py

@@ -17,12 +17,12 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'rli_template'
-copyright = '2020, Reiner Lemoine Institut'
+project = 'simbev'
+copyright = '2023, Reiner Lemoine Institut'
 author = 'Reiner Lemoine Institut'
 
 # The full version, including alpha/beta/rc tags
-release = '0.0.1'
+release = '2.0.0'
 
 
 # -- General configuration ---------------------------------------------------
@@ -47,10 +47,14 @@
 # a list of builtin themes.
 #
 
+import sphinx_rtd_theme
+
 html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+html_css_files = ['style.css']

docs/source/features.rst

@@ -1,13 +1,62 @@
-Features - overview
-=========================
+Features
+========
 
 This section presents the main features and functions to use in SimBEV.
 
-SimBEV - core
-----------------------------------------------
+.. contents:: Table of Contents
 
-.. automodule:: simbev.simbev.simbev_class
+simbev.car
+----------
+
+.. automodule:: simbev.car
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+simbev.mid_timeseries
+-----------
+
+.. automodule:: simbev.mid_timeseries
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+simbev.plot
+-----------
+
+.. automodule:: simbev.plot
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+simbev.region
+-----------
+
+.. automodule:: simbev.region
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+simbev.simbev_class
+-------------------
+
+.. automodule:: simbev.simbev_class
    :members:
    :undoc-members:
    :show-inheritance:
 
+simbev.trip
+-----------
+
+.. automodule:: simbev.trip
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 0
+
+   simbev.helpers

docs/source/getting_started.rst

@@ -2,43 +2,35 @@
 Getting started
 ~~~~~~~~~~~~~~~
 
-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
-
-
 .. contents::
     :depth: 1
     :local:
     :backlinks: top
 
-
-Documentation
-=============
-
-Full documentation can be found `here <https://simbev.readthedocs.io/en/latest/>`_
-
-Installing simBEV
+Installing SimBEV
 =================
 
 Install using pip
 -----------------
 
-First, clone via SSH using
+First, clone via SSH:
 
 .. code:: bash
 
     git clone [email protected]:rl-institut/simbev.git /local/path/to/simbev/
 
+or via HTTPS:
+
+.. code:: bash
+
+    git clone https://github.com/rl-institut/simbev.git
+
 Make sure you have Python >= 3.8 installed, let's create a virtual env:
 
 .. code:: bash
 
-    virtualenv --python=python3.8 simbev
-    source simbev/bin/activate
+    python3 -m venv venv
+    source venv/bin/activate
 
 Install package with
 
@@ -51,53 +43,19 @@ Install using conda
 
 Make sure you have conda installed, e.g. miniconda. Then create the env:
 
+.. code:: bash
+
     conda create -n simbev /local/path/to/simbev/environment.yml
     conda activate simbev
 
-General concept
-===============
-
-Simbev forecast charging demand for different e-cars for a pregiven time period. It does so by analysing the mobility in Germany
-data. This data is split into different region types ( Ländliche Regionen LR_Klein - Kleinstädtischer, dörflicher Raum LR_Mitte
-- Mittelstädte, städtischer Raum LR_Zentr - Zentrale Stadt Stadtregionen SR_Klein - Kleinstädtischer, dörflicher Raum SR_Mitte
-- Mittelstädte, städtischer Raum SR_Gross - Regiopolen, Großstädte SR_Metro - Metropole).
-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.
-
-Structure of the Simbev module
-==============================
-
-TODO
-
-Functions
-==========
-
-TODO
 
-Examples
-========
+Start Simulating
+================
 
-TODO
+The following code already simulates the default scenario in the folder scenarios/default/.
 
-Scenarios
-=========
-
-See directory `scenarios`.
-
-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.
+.. code:: bash
 
-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.
+    python -m simbev
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+More about simulating: :doc:`usage_details`

docs/source/index.rst

@@ -8,17 +8,10 @@ Welcome to SimBEV's documentation!
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
-
+   :caption: Contents
+
+   simbev_intro
    getting_started
    usage_details
+   simulation_settings
    features
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/source/simbev.helpers.rst

@@ -0,0 +1,21 @@
+simbev.helpers package
+======================
+
+Submodules
+----------
+
+simbev.helpers.errors module
+---------------------------------
+
+.. automodule:: simbev.helpers.errors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+simbev.helpers.helpers module
+---------------------------------
+
+.. automodule:: simbev.helpers.helpers
+   :members:
+   :undoc-members:
+   :show-inheritance: