diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e69de29..1c7c11a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing + +We welcome contributions! If you have any questions, you can [get in touch with the `timex_lca` developers ](mailto:timo.diepers@ltt.rwth-aachende.de) + + +## Contributing to the code, examples or documentation + +If you want to contribute to the development our code with a new feature, want to share your timex-example or add to the documentation, please follow the [GitHub contribution workflow (fork, branch, PR)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) to share your work. + +## Report bugs or errors + +Something is not working as expected? You have two options: + +### đŸĨˆ Report an error +Please open a new issue in the `timex_lca` [repository](https://github.com/TimoDiepers/timex/issues), describing the error and where you found it. +A member of the timex_lca developer community will then take care of the issue, but it may take some time for your issue to be resolved. + +### đŸĨ‡ Fix an error yourself +If you have a solution to the error, you can [create a fork](https://github.com/TimoDiepers/timex/forks) of the `timex_lca` repository, make your changes and [create a pull request](https://github.com/TimoDiepers/timex/pulls). The developers will assess the changes and be eternally grateful! + +[code of conduct]: codeofconduct diff --git a/docs/content/contributing.md b/docs/content/contributing.md index 2f5cd5e..50cc5cd 100644 --- a/docs/content/contributing.md +++ b/docs/content/contributing.md @@ -1,17 +1,3 @@ ```{include} ../../CONTRIBUTING.md -``` -# Contributing -```{note} -We are sorry to find you on this page! But we are happy to help you with your problem. Please follow the steps below to report a bug or error. -``` - -## đŸĨˆ Report an error -Please open a new issue in the `timex_lca` [repository](https://github.com/TimoDiepers/timex/issues), describing the error and where you found it. -A member of the timex_lca developer community will then take care of the issue, but it may take some time for your issue to be resolved. - -## đŸĨ‡ Fix an error yourself -If you have a solution to the error, you can create a fork of the `timex_lca` repository, make your changes and create a pull request. The developers will assess the changes and be eternally grateful! -Here is a description of the [GitHub contribution workflow (fork, branch, PR)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests). - -[code of conduct]: codeofconduct +``` \ No newline at end of file diff --git a/docs/content/data/example_ab_dark.svg b/docs/content/data/example_ab_dark.svg new file mode 100644 index 0000000..81f13bb --- /dev/null +++ b/docs/content/data/example_ab_dark.svg @@ -0,0 +1,128 @@ + + + + + + + B + + + A + „A + consumes + 2 + x + + 20% + of + B + at + t + A + and 2 + x + + 80% at + t + A + +1” + 2 + e + mission X + 5 + + t = + t + A + : 20% + t = t + A + +1: 80% + + t = + t + B + : 60% + t = t + B + +1: 40% + „B + emits + 5 + x + + 60% + of + X at + t + B + and 5 + x + + 40% at + t + B + +1” + + + + \ No newline at end of file diff --git a/docs/content/data/example_ab_light.svg b/docs/content/data/example_ab_light.svg new file mode 100644 index 0000000..6a2bbfa --- /dev/null +++ b/docs/content/data/example_ab_light.svg @@ -0,0 +1,218 @@ + + + + + + + + B + + + + + A + + + „A + + + consumes + + + 2 + + + x + + + 20% + + + of + + + B + + + at + + + t + + + A + + + and 2 + + + x + + + 80% at + + + t + + + A + + + +1” + + + 2 + + + e + + + mission X + + + 5 + + + + t = + + + t + + + A + + + : 20% + + + t = t + + + A + + + +1: 80% + + + + t = + + + t + + + B + + + : 60% + + + t = t + + + B + + + +1: 40% + + + „B + + + emits + + + 5 + + + x + + + 60% + + + of + + + X at + + + t + + + B + + + and 5 + + + x + + + 40% at + + + t + + + B + + + +1” + + + + + \ No newline at end of file diff --git a/docs/content/theory.rst b/docs/content/theory.rst index 5fa2e5b..9454616 100644 --- a/docs/content/theory.rst +++ b/docs/content/theory.rst @@ -1,16 +1,16 @@ Theory ======== -Here's a flow chart of how ``timex_lca`` works: +This section explains some of the theory behind ``timex_lca``. Check out the flow chart below for a quick overview of how it all comes together, and you'll find more detailed explanations of each step in the following subsections. .. image:: data/method_dark.svg :class: only-dark - :height: 500px + :height: 450px :align: center .. image:: data/method_light.svg :class: only-light - :height: 500px + :height: 450px :align: center User input @@ -20,34 +20,14 @@ User input 1. a static foreground system model with 2. temporal information using the attribute ``temporal_distribution`` on technosphere or biosphere exchanges in the foreground system modeel, and -3. a set of background databases, which must have a reference in time.` - -.. raw:: html - -
- - ℹī¸ - More info on inputs - -
- -
-
- - +3. a set of background databases, which must have a reference in time. + +.. dropdown:: ℹī¸ More info on inputs + + - The foreground system must have exchanges linked to one of the background databases. These exchanges at the intersection between foreground and background databases will be relinked by `timex_lca`. + - Temporal distributions can occur at technosphere and biosphere exchanges and can be given in various forms, see `bw_temporalis `__, including absolute (e.g. 2024-03-18) or relative (e.g. 3 years before) nature and can have different temporal resolution (down to seconds but later aggregation supports resolutions down to hours). + - Temporal distributions are optional. If none are provided, no delay between producing and consuming process is assumed and the timing of the consuming process is adopted also for the producing process. + Graph traversal ---------------- @@ -67,11 +47,19 @@ We recommend aligning ``temporal_grouping``, which defaults to 'year', to align For a simple example that consists of the following system: a process A that consumes an exchange b from a process B, which emits an emission x and both the exchange b and the emission x occur at a certain point in time - (add flowchart dummy system) - the timeline would look like this: + .. image:: data/example_ab_dark.svg + :class: only-dark + :height: 300px + :align: center - + .. image:: data/example_ab_light.svg + :class: only-light + :height: 300px + :align: center + + | + The resulting timeline looks like this: +-------+-----------+----------+-----------------+ | time | producer | consumer | amount | @@ -90,8 +78,8 @@ Available matching strategies are: closest database or linear interpolation betw Modified matrices ------------------ -.. _`BW_processing`: https://github.com/brightway-lca/bw_processing?tab=readme-ov-file -``timex_lca`` now modifies the technopshere and biosphere matrices using ``datapackages`` from `BW_processing`_. +.. _`bw_processing`: https://github.com/brightway-lca/bw_processing?tab=readme-ov-file +``timex_lca`` now modifies the technopshere and biosphere matrices using ``datapackages`` from `bw_processing`_. Technosphere matrix modifications: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/index.md b/docs/index.md index 05bf899..fcb1c18 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,12 +1,24 @@ -> ⚠ī¸ This is a work in progress. Please refer to the [Timex Readme on GitHub](https://github.com/TimoDiepers/timex) for now. +> ⚠ī¸ This package is still under development and some functionalities may change in the future. # `timex_lca` -This is a python package for time-explicit Life Cycle Assessment, building on top of [Brightway](https://docs.brightway.dev/en/latest). With `timex_lca`, you can consider both the: -- timing of processes & 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). +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). -Users can define temporal distributions for process and emission exchanges, which are then *automatically* mapped to corresponding time-explicit databases. Consequently, the resulting time explicit LCI reflects the current technology status within the production system at the actual time of each process. +## Features: +This package enables you to account for: +- **Timing of processes** throughout the supply chain (e.g., end-of-life treatment occurs 20 years after construction) +- **Variable** and/or **evolving** supply chains & technologies (e.g., increasing shares of renewable electricity in the future) +- **Timing of emissions** (by applying dynamic characterization functions) + +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. + +## Use cases: +`timex_lca` is ideal for cases with: +- **Variable** or strongly **evolving production systems** +- **Long-lived** products +- **Biogenic** carbon + +Here's a visualization of what `timex_lca` can do for you: ```{image} content/data/timex_dark.svg :class: only-dark