Merge pull request #181 from pledge4future/documentation

Documentation
pledge4future · May 5, 2024 · 0a703ad · 0a703ad
2 parents f71a271 + 3bcec4d
commit 0a703ad
Show file tree

Hide file tree

Showing 10 changed files with 162 additions and 160 deletions.
diff --git a/docs/businesstrips.rst b/docs/businesstrips.rst
diff --git a/docs/calculate/electricity.rst b/docs/calculate/electricity.rst
@@ -0,0 +1,10 @@
+===========
+Electricity
+===========
+
+.. contents::
+
+
+Electricity emissions are computed based on the consumption (in kWh) and the emission factors for a specified energy mix or energy source.
+
+.. autofunction:: co2calculator.calculate.calc_co2_electricity
diff --git a/docs/calculate/emission_factors.rst b/docs/calculate/emission_factors.rst
@@ -6,8 +6,6 @@ For computing emissions, a central piece of information is the emission intensit
 These are expressed by emission factors.
 Below, you can find a list of all activities and their emission factors (in co2e per unit).
 Within one category, the emission intensity may differ drastically depending on the specification
-Let's take a trip by car. A medium battery electric car emits around 0.056 kg co2e/km (including emissions from
-manufacturing), while an average car driving on gasoline emits 0.224 kg co2e/km.
 
 .. csv-table:: Conversion factors heating
     :file: ../../data/emission_factors.csv

diff --git a/docs/calculate/heating_electricity.rst → docs/calculate/heating.rst b/docs/calculate/heating_electricity.rst → docs/calculate/heating.rst
@@ -1,11 +1,7 @@
-=======================
-Heating and electricity
-=======================
-
-.. contents::
 
+=======
 Heating
--------
+=======
 
 Heating emissions are computed based on the consumption (typically in kWh) and the emission factors for a specified fuel type.
 
@@ -20,13 +16,6 @@ In these cases, it is possible to specify the `unit`. The consumption will then
     :stub-columns: 2
     :widths: 10 30 30 30
 
-The parameter `area_share` accounts for the fact, that the heating energy consumption may often only be known for an entire building, while a working group just occupies parts of the buildin.
+The parameter `area_share` accounts for the fact, that the heating energy consumption may often only be known for an entire building, while a working group just occupies parts of the building.
 In this case, the (approximate) share of the building floor space, that is occupied by the working group can be provided.
 The `area_share` must be between 0.0 and 1.0 and is 1.0 by default.
-
-Electricity
------------
-
-Electricity emissions are computed based on the consumption (in kWh) and the emission factors for a specified energy mix or energy source.
-
-.. autofunction:: co2calculator.calculate.calc_co2_electricity
diff --git a/docs/calculate/transport_modes.rst b/docs/calculate/transport_modes.rst
@@ -4,32 +4,40 @@ Transportation modes
 
 .. contents::
 
-Business trips can be calculated for different modes of transport.
+Trips can be calculated for different modes of transport.
 The overview here summarizes, which parameters influence the carbon emission intensity of a trip for the different transportation modes.
 The specific emission factors for different configurations (e.g., vehicle size, fuel type, etc.) are documented under
 :doc:`Emission factors <emission_factors>`.
 
 Car trip
 --------
 The quantity of CO2e emitted by a car trip depends on the ``fuel_type`` (average, cng, diesel, electric, gasoline,
-hybrid, hydrogen, plug-in_hybrid), car ``size`` (average, small, medium, large) and the number of ``passengers``.
+hybrid, plug-in_hybrid), car ``size`` (average, small, medium, large) and the number of ``passengers``.
 
 Bus trip
 --------
-The quantity of CO2e emitted by a bus trip depends on the bus ``size`` (average, medium, large) and the
-``occupancy`` in % (20, 50, 80, 100). The ``vehicle_range`` is set to long-distance automatically.
+The quantity of CO2e emitted by a bus trip depends on the bus ``size`` (average, small, medium, large)and the ``vehicle_range`` (local, long-distance).
 
 Train trip
 ----------
-The quantity of CO2e emitted by a train trip depends on the ``fuel_type`` (average, electric, diesel).
-The ``vehicle_range`` is set to long-distance automatically.
+The quantity of CO2e emitted by a train trip depends on the ``vehicle_range`` (local, long-distance).
 
 Plane trip
 ----------
 The quantity of CO2e emitted by a plane trip depends on the
-``seating_class`` (average, economy_class, business_class, premium_economy_class, first_class).
+``seating_class`` (average, economy_class, business_class, first_class).
 
 Ferry trip
 ----------
 The quantity of CO2e emitted by a ferry trip depends on the
 ``seating_class`` (average, Foot passenger, Car passenger).
+
+
+Motorbike trip
+--------------
+The quantity of CO2e emitted by a motorbike trip depends on the ``size`` (average, small, medium, large) of the
+motorbike.
+
+Tram, trolleybus, bicycle or pedelec trip
+-----------------------------------------
+For tram, trolleybus, bicylce or pedelec, no specifica have to be provided.
diff --git a/docs/conf.py b/docs/conf.py
@@ -68,7 +68,7 @@
 html_theme_options = {
     "body_max_width": "none",
     "page_width": "80%",
-    "sidebar_width": "350px",
+    "sidebar_width": "250px",
     "fixed_sidebar": "true",
     "github_button": "true",
     "github_user": "pledge4future",