Merge pull request #90 from brightway-lca/update_readme

Update readme

README.md

@@ -9,37 +9,35 @@
 [![PyPI - Version](https://img.shields.io/pypi/v/bw-timex?color=%2300549f)](https://pypi.org/project/bw-timex/)
 [![Conda Version](https://img.shields.io/conda/v/diepers/bw_timex?label=conda)](https://anaconda.org/diepers/bw_timex)
 ![Conda - License](https://img.shields.io/conda/l/diepers/bw_timex)
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/brightway-lca/bw_timex/HEAD?labpath=notebooks%2Fexample_electric_vehicle_standalone.ipynb)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/brightway-lca/bw_timex/HEAD?labpath=notebooks%2Fgetting_started.ipynb)
 
-> ℹ️ _This package is still under development and some functionalities may change in the future._
+This is a python package for [time-explicit Life Cycle Assessment](https://docs.brightway.dev/projects/bw-timex/en/latest/content/theory.html#terminology) that helps you assess the environmental impacts of products and processes over time. `bw_timex` builds on top of the [Brightway LCA framework](https://docs.brightway.dev/en/latest).
 
-This is a python package for time-explicit Life Cycle Assessment that helps you assess the environmental impacts of products and processes over time. `bw_timex` builds on top of the [Brightway LCA framework](https://docs.brightway.dev/en/latest).
-
-## Features
+## ✨ 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, `bw_timex` keeps track of the timing of emissions which means that you can apply [dynamic characterization functions](https://github.com/TimoDiepers/dynamic_characterization).
 
-## Use cases
+## 💡 Use Cases
 `bw_timex` is ideal for cases with:
 - **Variable** or strongly **evolving production systems**
 - **Long-lived** products
 - **Biogenic** carbon
 
-## Documentation and Resources
-- [Full Documentation](https://docs.brightway.dev/projects/bw-timex/en/latest/)
+## 👩‍💻 Getting Started
 - [Installation Guide](https://docs.brightway.dev/projects/bw-timex/en/latest/content/installation.html)
-- [Example Notebook](https://docs.brightway.dev/projects/bw-timex/en/latest/content/examples/example_ev.html)
+- [Getting Started Tutorial](https://docs.brightway.dev/projects/bw-timex/en/latest/content/getting_started/index.html)
+- [Example Collection](https://docs.brightway.dev/projects/bw-timex/en/latest/content/examples/index.html)
 
-## Contributing
+## 🤝 Contributing
 We welcome contributions! If you have suggestions or want to fix a bug, please:
 - [Open an Issue](https://github.com/brightway-lca/bw_timex/issues)
 - [Send a Pull Request](https://github.com/brightway-lca/bw_timex/pulls)
 
-## Support
+## 💬 Support
 If you have any questions or need help, do not hesitate to contact us:
 - Timo Diepers ([timo.diepers@ltt.rwth-aachen.de](mailto:timo.diepers@ltt.rwth-aachen.de))
 - Amelie Müller ([a.muller@cml.leidenuniv.nl](mailto:a.muller@cml.leidenuniv.nl))

docs/conf.py

@@ -171,7 +171,7 @@
 
 html_theme_options = {
     # page elements
-    "announcement": "⚠️ This package is under active development and some functionalities may change in the future.",
+    # "announcement": "⚠️ placeholder",
     "navbar_start": ["navbar-logo"],
     "navbar_end": ["theme-switcher", "navbar-icon-links.html"],
     "navbar_align": "content",

docs/content/examples/index.md

@@ -1,4 +1,4 @@
-# TimexLCA Examples
+# Example Collection
 
 Here are some examples on how you can use `bw_timex`.
 

docs/content/theory.md

@@ -14,7 +14,7 @@ LCA terminology can be confusing sometimes. Here's an attempt of visualizing wha
 
 ## Data requirements
 
-For a time-explicit LCA, 3 inputs are required:
+For a time-explicit LCA, three inputs are required:
 
 1.  a static foreground system model with
 2.  temporal information using the attribute `temporal_distribution` on

docs/index.md

@@ -2,21 +2,21 @@
 
 `bw_timex` is a python package for [time-explicit Life Cycle Assessment](content/theory.md#terminology) that helps you assess the environmental impacts of products and processes over time. `bw_timex` builds on top of the [Brightway LCA framework](https://docs.brightway.dev/en/latest).
 
-## Features
+## ✨ 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, `bw_timex` keeps track of the timing of emissions, which means that you can apply dynamic characterization functions.
 
-## Use cases
+## 💡 Use Cases
 `bw_timex` is ideal for cases with:
 - **Variable** or strongly **evolving production systems**
 - **Long-lived** products
 - **Biogenic** carbon
 
-## Support
+## 💬 Support
 If you have any questions or need help, do not hesitate to contact us:
 - Timo Diepers ([timo.diepers@ltt.rwth-aachen.de](mailto:timo.diepers@ltt.rwth-aachen.de))
 - Amelie Müller ([a.muller@cml.leidenuniv.nl](mailto:a.muller@cml.leidenuniv.nl))