Skip to content

Commit ba90442

Browse files
committed
readme restructure
1 parent 48ae2d2 commit ba90442

File tree

5 files changed

+392
-54
lines changed

5 files changed

+392
-54
lines changed

README.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,31 @@
1010
[![Conda Version](https://img.shields.io/conda/v/diepers/timex_lca?label=conda)](https://anaconda.org/diepers/timex_lca)
1111
![Conda - License](https://img.shields.io/conda/l/diepers/timex_lca)
1212

13-
> ℹ️ *This package is still under development and some functionalities may change in the future.*
13+
> ℹ️ _This package is still under development and some functionalities may change in the future._
1414
15-
This is a python package for __time-explicit Life Cycle Assessment (LCA)__, building on top of the [Brightway](https://docs.brightway.dev/en/latest) LCA framework.
15+
This is a python package for time-explicit Life Cycle Assessment that helps you assess the environmental impacts of products and processes over time. `timex_lca` builds on top of the [Brightway LCA framework](https://docs.brightway.dev/en/latest).
1616

17-
Time-explicit LCA aims to treat time more coherently in LCA, by __streamlining dynamic LCI and LCIA with prospective LCI databases__. As such, `timex_lca` enables the consideration of both the __timing of processes and emissions__ (e.g., end-of-life treatment occurs 20 years after construction), as well as the __changing state__ of the production system (e.g., increasing shares of renewable electricity in the future).
17+
## Features
18+
This package enables you to account for:
19+
- **Timing of processes** throughout the supply chain (e.g., end-of-life treatment occurs 20 years after construction)
20+
- **Variable** and/or **evolving** supply chains & technologies (e.g., increasing shares of renewable electricity in the future)
21+
- **Timing of emissions** (by applying dynamic characterization functions)
1822

19-
Users can define the timing of process and emission exchanges as *temporal distributions*. `timex_lca` automatically propoagates the temporal information through the supply chain and sources the LCI data from the corresponding time explicit database. As the timing of each emission is recorded, `timex_lca` supports __dynamic LCIA methods__, which are provided for the climate change metrics radiative forcing and global warming potential.
23+
You can define temporal distributions for process and emission exchanges, which are then *automatically* propagated through the supply chain and mapped to corresponding time-explicit databases. The resulting time-explicit LCI reflects the current technology status within the production system at the actual time of each process. Also, `timex_lca` keeps track of the timing of emissions which means that you can apply dynamic characterization functions.
2024

21-
Time explicit LCA can provide more representative LCA results for use cases, such as:
22-
- products with variable or evolving production systems
23-
- long-lived products
24-
- products with biogenic carbon
25+
## Use cases:
26+
`timex_lca` is ideal for cases with:
27+
- **Variable** or strongly **evolving production systems**
28+
- **Long-lived** products
29+
- **Biogenic** carbon
2530

26-
### Quick links:
27-
All [documentation](https://timex.readthedocs.io/en/latest/), including detailed description of `timex_lca`.
31+
## Documentation and Resources:
32+
- [Full Documentation](https://timex.readthedocs.io/en/latest/)
33+
- [Installation Guide](https://timex.readthedocs.io/en/latest/content/installation.html)
34+
- [Example Notebook](https://github.com/TimoDiepers/timex/blob/main/notebooks/example_setac.ipynb)
2835

29-
[Installation instructions](https://timex.readthedocs.io/en/latest/content/installation.html)
30-
31-
[Example notebook](https://github.com/TimoDiepers/timex/blob/main/notebooks/example_setac.ipynb)
32-
33-
34-
### Questions and remarks:
35-
For suggestions of improvements or reporting of bugs, please open an issue on the Github page, send a pull request or directly contact the maintainers.
36+
### Contributing:
3637

38+
We welcome contributions! If you have suggestions or want to fix a bug, please:
39+
- [Open an Issue](https://github.com/TimoDiepers/timex/issues)
40+
- [Send a Pull Request](https://github.com/TimoDiepers/timex/pulls)

docs/content/data/example_ab_dark.svg

Lines changed: 128 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)