Skip to content

Commit

Permalink
some more markdown enhancements
Browse files Browse the repository at this point in the history
  • Loading branch information
codingfabi committed May 4, 2024
1 parent 347ca41 commit af7b161
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Welcome to co2calculator's documentation!

**co2calculator** is a Python package to calculate work related CO2 emissions from heating and electricity consumption as well as business trips and commuting.


Contents
==================

Expand All @@ -19,6 +18,7 @@ Contents
:includehidden:

documentation
tutorial
businesstrips
commuting
calculate/heating_electricity
Expand Down
17 changes: 17 additions & 0 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Tutorial

The co2calculator package is available via pip:

```python
pip install co2calculator
```

For a simple and basic emission calculation, import the calculation function and define some emission cause:

```python

from co2calculator import calculate_trip
from co2calculator.enums import TransportationMode

co2e = calculate_trip(distance=200,transportation_mode=TransportationMode.CAR)
```

0 comments on commit af7b161

Please sign in to comment.