Skip to content

Commit

Permalink
update and restructure docs
Browse files Browse the repository at this point in the history
  • Loading branch information
han16nah committed May 5, 2024
1 parent f84220c commit bf74f96
Show file tree
Hide file tree
Showing 9 changed files with 94 additions and 99 deletions.
30 changes: 0 additions & 30 deletions docs/businesstrips.rst

This file was deleted.

10 changes: 10 additions & 0 deletions docs/calculate/electricity.rst
Original file line number Diff line number Diff line change
@@ -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
2 changes: 0 additions & 2 deletions docs/calculate/emission_factors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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
22 changes: 15 additions & 7 deletions docs/calculate/transport_modes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,15 @@
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",
"github_repo": "co2calculator",
"show_powered_by": "true",
"sidebar_header": "#f15e44",
"narrow_sidebar_bg": "#f15e44",
"font_family": "montserrat",
"font_family": "Roboto Condensed",
}

# Add any paths that contain custom static files (such as style sheets) here,
Expand Down
Loading

0 comments on commit bf74f96

Please sign in to comment.