Skip to content

Commit

Permalink
#11 moved "brightway-shine" to the new documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelweinold committed Jan 8, 2023
1 parent 75b874e commit 19b81dc
Show file tree
Hide file tree
Showing 2 changed files with 136 additions and 1 deletion.
3 changes: 2 additions & 1 deletion sphinx/homepage.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Contents
```{toctree}
---
hidden:
maxdepth: 2
maxdepth: 1
---
source/introduction/introduction
source/setup/setup
Expand All @@ -81,5 +81,6 @@ source/lca/lca
source/contributing/contributing
source/faq/faq
source/changelog/index
source/other/ecosystem
source/other/credits
```
134 changes: 134 additions & 0 deletions sphinx/source/other/ecosystem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
# Brightway Ecosystem

![Brightway](https://img.shields.io/static/v1?label=Brightway&message=Ecosystem&color=45bfb0&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTA2NSIgaGVpZ2h0PSI2OTAiIHZlcnNpb249IjEuMSIgdmlld0JveD0iMCAwIDEwNjUgNjkwIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgogPGRlZnM+CiAgPGNsaXBQYXRoIGlkPSJjbGlwUGF0aDIxNzMiPgogICA8cGF0aCBkPSJtLTU5NSA0NDBoMWUzdi0xZTNoLTFlM3oiLz4KICA8L2NsaXBQYXRoPgogPC9kZWZzPgogPGcgdHJhbnNmb3JtPSJtYXRyaXgoMS4zIDAgMCAtMS4zIDY1MyA0MDMpIiBjbGlwLXBhdGg9InVybCgjY2xpcFBhdGgyMTczKSIgZmlsbD0iI2ZmZiI+CiAgPHBhdGggZD0ibTAgMGMwLTEuMi0xLjUtMy40LTAuNDctNS4yIDEuMy0yLjQgNS40LTEuNSA1LjgtM3YtMC4wMThsLTQuNy0wLjA1NC0yLTQuMWMtMS45IDAuNzEtMi40IDMuMi0zLjIgNi42LTAuNDQgMi0wLjcxIDMuNCAwLjA4OSA0LjctMTQtMy4zLTMwLTUuNC00NS01LjQtNDkgMC4wMzYtNzEgMTctMTA3IDI0IDEuNS0xLjEgMi43LTMuMyAyLjEtNC45bC02LjEgMi4yLTQtMy4xYy0xLjQgMS40LTAuNTggMi44LTIuMiA0LjgtMi4xIDIuNS01LjMgMi42LTUuMiAzIDAuODctMC4wNzIgMS43LTAuMTQgMi42LTAuMjItMS42IDAuMjQtMi41IDAuNC0yLjYgMC4yMi0zLjkgMC4zMS04IDAuNDktMTIgMC41MS02NiAwLjIyLTEwMi00Mi0xMjItNzkgMy42IDIuOSA4LjcgMS41IDEwIDEuMSA0LjItMS4xIDguOC00LjEgOC40LTYuMWwtNC41LTEuNSAwLjUyLTAuNTRjLTAuMjItMC4wMTktMC40My0wLjAxOS0wLjY1LTAuMDE5LTQuMiAwLjA1NS01LjEgMy45LTkuMiA0LjItMy44IDAuMjktNi40LTIuNy03LjItMS45LTEzLTI3LTE4LTUwLTE4LTUwaC0zNHM2LjcgMzQgMzAgNjhjLTEuNiAxIDEgNS0xLjEgOC4zLTIuNSAzLjgtOC40IDIuNC04LjggNC41LTAuMDE4IDAuMTMtMC4wMzYgMC4yNSAwIDAuMzhsNy4yLTAuNTIgMi41IDUuNWMxLjEtMC40IDItMS43IDMuOS00LjIgMS40LTEuOCAyLjQtMy4yIDMuMS00LjMgMjYgMzQgNjkgNjcgMTM5IDY3IDIuNSAwIDUtMC4wNzMgNy40LTAuMi0wLjU4IDIuMSA1IDMuNSA1LjcgOC4xIDAuNzQgNC44LTQuNyA3LjgtMy40IDEwIDAuMDE4IDAuMDE4IDAuMDM2IDAuMDU0IDAuMDU0IDAuMDcybDUuOC00LjQgNC43IDMuMWMwLjU2LTAuODcgMC42My0xLjctMC40NS04LTEuNC04LjItMS45LTktMi43LTkuNyA0MS01LjIgNjgtMjggMTE4LTI5IDE1LTAuNTQgMzAgMC43OCA0NCAzLjEtMC4yNyAwLjE2LTAuNTIgMC4zNi0wLjc2IDAuNjItMSAxLjEtMS4xIDMuMS0xLjQgNy4xLTAuMjUgNC4zLTAuNCA2LjYgMC40MiA3LjdsMi44LTMuMiAzLjIgMS4yYzAuMDM2LTAuMDcyIDAuMDU0LTAuMTYgMC4wNzItMC4yNCAwLjQ0LTEuOC0xLjEtMi43LTEuMS01LjYgMC0zLjUgMi4zLTQuOSAxLjgtNi41LTAuMDM2LTAuMDktMC4wNzItMC4xOC0wLjExLTAuMjUgNDUgOC43IDc4IDI4IDc5IDI4IDAtMC42My0zNS0yMi03OS0zM20tMzMyLTMwLTU1IDQuMS0zNSA0MC0xNyAyOC0xNSAyNC05LjcgMjctMjYgMTYgMzgtOS40IDM5LTI0IDMxLTI4IDI3LTM5IDE5LTMzem00MTEgNjUgMTEgNzkgNTcgNDYgNjggOS4zIDQ1LTAuMzkgNDcgMTYtMTYtMzYtMTMtMzQtMjQtNTgtMzItNDktMzktMjAtNDMgMy43em04OC0yNDktMTggMzItMjEgMjYtMzUgMzQtMjEgMjYtMjAgMjItMzcgNDgtMTcgMjAgNzAgMC44NyA1Ni00OSAyMi00MCAxNS0zNyAyLjgtMzJ6bTAgMC0xNyAxNy0zOSA2LjItNDQgMTMtNTAgMzMtMzAgNTUtMy4zIDUzIDEzIDI3IDEuOSAzLjcgMTctMjAgMzctNDggMjAtMjIgMjEtMjYgMzUtMzQgMjEtMjZ6bS05MSAzNDgtMTYtNTctMzEtNDYtMzMtMTIgMC4xNSAzLjkgMS42IDQ0IDQuNCAzNiA1LjEgMzQgNC4zIDQwIDIgMzQgMi4zIDM2IDEzIDQyIDQuNS0zNyAxNi0yMiAyMC0zN3ptLTQ3IDE1NC0xMy00Mi0yLjMtMzYtMi0zNC00LjMtNDAtNS4xLTM0LTQuNC0zNi0xLjYtNDQtMC4xNS0zLjktMi44IDMuMi00OCA1NS03LjIgMzcgMC43OCA2NCAyNiA0OCAzMyAyOXptLTE0NS0zOTktMjAgNDMtMTIgNDEtNi4xIDI0LTYuNyAyMCA1OC0yMSAxNS0yNiAxNi00NC00LjItMzctMTItNjEtNS4yIDI0em0yOC02MS0yNyAxOS0yMCAxMS0yOCAyMC0zMSAzMC02LjggNDggMTcgNDIgMjQgMTggMS41LTQuNiA1LjItMTYgNi4xLTI0IDEyLTQxIDIwLTQzIDIyLTM3em0tMTEgMzA1LTE4LTUxLTUyLTM0LTAuMjUgNS44LTAuODMgMTkgMS4yIDM5LTMuMSA0My02LjcgMzgtMTEgNDYtMTUgNjMgMjAtMjUgNDMtNDEgMzAtNDl6bS03MC03OSAwLjI1LTUuOC01NiA0Mi0xNyA2NSAyLjcgNTAgOS40IDQwIDE2IDE3IDguNCA0MCAxNS02MyAxMS00NiA2LjctMzggMy4xLTQzLTEuMi0zOXptLTU0LTE5NC0xMiAyMC0yMiAyNi0xOCAxNS0xNyAxNy0wLjEzLTAuNTYtOS43LTQ1IDIxLTM0IDIzLTEzIDIxLTguMiAzNy0xOS0xNSAxM3ptMjQtNDEtMTUgMTMtOC4zIDI4LTEyIDIwLTIyIDI2LTE4IDE1LTE3IDE3IDQyIDE0IDI0LTQuOCAxNS0xNiA4LjYtMzMgMS41LTI4LTMuNC0yMHptLTExMCAyMDItMjMtNTEtMi44IDQuOS0xOSAzMy0yNyAzOS0zMSAyOC0zOSAyNC0zOCA5LjQgMzIgMS4zIDMxIDEuNiAzMC0wLjI5IDQzLTE2IDMwLTMweiIvPgogPC9nPgo8L3N2Zz4K)

Projects that use Brightway are featured here. If you would like to add your project, simply add it to this page by opening a pull request.

## Projects extending Brightway

```{note}
These repositories add some functionality to the core `brightway-lca` code base.
```

### Activity Browser

![GitHub last commit](https://img.shields.io/github/last-commit/LCA-ActivityBrowser/activity-browser?logo=GitHub) ![GitHub contributors](https://img.shields.io/github/contributors/LCA-ActivityBrowser/activity-browser?logo=GitHub) ![GitHub Repo stars](https://img.shields.io/github/stars/LCA-ActivityBrowser/activity-browser?style=social)

| author | project source | project documentation |
| ------ | -------------- | --------------------- |
| Activity Browser team | [`activity-browser`](https://github.com/LCA-ActivityBrowser/activity-browser) | [`GitHub readme`](https://github.com/LCA-ActivityBrowser/activity-browser) |

A graphical user interface for brightway (cross platform and open source). It extends brightway in a number of way and provides users a more convenient way for standard tasks in brightway, such as inventory modeling and the analysis of LCA results.


### `presamples`

![GitHub last commit](https://img.shields.io/github/last-commit/PascalLesage/presamples?logo=GitHub) ![GitHub contributors](https://img.shields.io/github/contributors/PascalLesage/presamples?logo=GitHub) ![GitHub Repo stars](https://img.shields.io/github/stars/PascalLesage/presamples?style=social)

| author | project source | project documentation |
| ------ | -------------- | --------------------- |
| [PascalLesage](https://github.com/PascalLesage/) | [`presamples`](https://github.com/PascalLesage/presamples) | [readthedocs.org page](https://presamples.readthedocs.io/en/latest/) |

Package to write, load, manage and verify numerical arrays, called presamples. Presamples can replace values in the matrices used in LCA as calculations are carried out. Presamples can also store parameters used in parameterized brightway models. This integration is seamless in brightway2:

```python
lca = bw.LCA({act:1}, presamples=[list_of_paths_to_presample_packages])
```

Storing and injecting specific values in LCA matrices can improve LCA calculations in many ways:

* Storing and reusing data characterizing given scenarios makes scenario analysis much easier.
* It can easily integrate time series.
* It can use pre-generated static or stochastic values that were generated by complex, non-linear models, allowing the
LCA model to capture system dynamics more accurately.
* It is possible to account to correlation across parameters during Monte Carlo Simulations (e.g. for correlation
between characterization factors, between fuel use and CO2 emissions, etc.
* Since sampled data can be used directly, it is unnecessary to fit data to a distribution.


### `brightway2-aggregated`

![GitHub last commit](https://img.shields.io/github/last-commit/CIRAIG/brightway2-aggregated?logo=GitHub) ![GitHub contributors](https://img.shields.io/github/contributors/CIRAIG/brightway2-aggregated?logo=GitHub) ![GitHub Repo stars](https://img.shields.io/github/stars/CIRAIG/brightway2-aggregated?style=social)


| author | project source | project documentation |
| ------ | -------------- | --------------------- |
| [CIRAIG](https://github.com/CIRAIG) | [`brightway2-aggregated`](https://github.com/CIRAIG/brightway2-aggregated) | [readthedocs.org page](https://brightway2-aggregated.readthedocs.io/en/latest/) |

This package provides tools for the creation and use of aggregated (i.e. cradle-to-gate) LCA data, both at the LCI and LCIA score level.


### `bw2landbalancer`

![GitHub last commit](https://img.shields.io/github/last-commit/CIRAIG/bw2landbalancer?logo=GitHub) ![GitHub contributors](https://img.shields.io/github/contributors/CIRAIG/bw2landbalancer?logo=GitHub) ![GitHub Repo stars](https://img.shields.io/github/stars/CIRAIG/bw2landbalancer?style=social)


| author | project source | project documentation |
| ------ | -------------- | --------------------- |
| [CIRAIG](https://github.com/CIRAIG) | [`bw2landbalancer`](https://github.com/CIRAIG/bw2landbalancer) | [Jupyter Notebook](https://github.com/CIRAIG/bw2landbalancer/blob/master/Using%20bw2landbalancer.ipynb)


`bw2landbalancer` is a Python library used to create balanced land transformation samples to override unbalanced sample. Unbalanced samples arise when land transformation exchanges are independently sampled. bw2landbalancer rescales certain land transformation exchanges to ensure that the ratio of land transformation from exchanges and land transformation to exchanges is conserved. It is based on the Brightway2 LCA framework, and is meant to be used with [presamples](https://github.com/PascalLesage/presamples).


### `bw2waterbalancer`

![GitHub last commit](https://img.shields.io/github/last-commit/CIRAIG/bw2waterbalancer?logo=GitHub) ![GitHub contributors](https://img.shields.io/github/contributors/CIRAIG/bw2waterbalancer?logo=GitHub) ![GitHub Repo stars](https://img.shields.io/github/stars/CIRAIG/bw2waterbalancer?style=social)


| author | project source | project documentation |
| ------ | -------------- | --------------------- |
| [CIRAIG](https://github.com/CIRAIG) | [`bw2waterbalancer`](https://github.com/CIRAIG/bw2waterbalancer) | [`GitHub readme`](https://github.com/CIRAIG/bw2waterbalancer) |

`bw2waterbalancer` is a Python library used to create balanced water samples to override unbalanced sample. Unbalanced samples arise when water exchanges are independently sampled. bw2waterbalancer rescales certain exchanges to ensure that the ratio of water inputs to water outputs is conserved. It is based on the Brightway2 LCA framework, and is meant to be used with [`presamples`](https://github.com/PascalLesage/presamples).


### `lca_algebraic`

![GitHub last commit](https://img.shields.io/github/last-commit/oie-mines-paristech/lca_algebraic?logo=GitHub) ![GitHub contributors](https://img.shields.io/github/contributors/oie-mines-paristech/lca_algebraic?logo=GitHub) ![GitHub Repo stars](https://img.shields.io/github/stars/oie-mines-paristech/lca_algebraic?style=social)


| author | project source | project documentation |
| ------ | -------------- | --------------------- |
| [oie-mines-paristech](https://github.com/oie-mines-paristech) | [`lca_algebraic`](https://github.com/oie-mines-paristech/lca_algebraic) | [`GitHub readme`](https://github.com/oie-mines-paristech/lca_algebraic) |

This library is a layer above Brightway, briging symbolic calculus to it, for the definition of parametric inventories with fast computation of impacts, suitable for global sensivity analyis, based on Monte Carlo methods.

`lca_algebraic` provides a set of helper functions for :

* Compact & human readable definition of activites :
* search background (tech and biosphere) activities
* create new foreground activites with parametrized amounts
* parametrize / update existing background activities (extending the class **Activity**)
* Definition of parameters
* Fast computation of LCAs
* Computation of Monte Carlo method and Global Sensivity Analysis (Sobol indices)



## Projects using Brightway

```{note}
These repositories heavily use Brightway functionality.
```

### Global Sensitivity Analysis (Delta Moment-Independent Approach)

![GitHub last commit](https://img.shields.io/github/last-commit/bsteubing/lca-global-sensitivity-analysis?logo=GitHub) ![GitHub contributors](https://img.shields.io/github/contributors/bsteubing/lca-global-sensitivity-analysis?logo=GitHub) ![GitHub Repo stars](https://img.shields.io/github/stars/bsteubing/lca-global-sensitivity-analysis?style=social)


| author | project source | project documentation |
| ------ | -------------- | --------------------- |
| [bsteubing](https://github.com/bsteubing) | [`lca-global-sensitivity-analysis`](https://github.com/bsteubing/lca-global-sensitivity-analysis) | [`GitHub readme`](https://github.com/bsteubing/lca-global-sensitivity-analysis) |

This repository implements the delta moment-independent GSA approach from SaLib and adds some smart filtering to reduce the number of GSA input variables. Still, this way the entire background can be included in GSA. It is based on previous Monte Carlo Analysis (methods for that included in the repository as it needs to store the LCA input and output data). An implementation is also available in the Activity Browser .

### Modular LCA

![GitHub last commit](https://img.shields.io/github/last-commit/bsteubing/modular-lca?logo=GitHub) ![GitHub contributors](https://img.shields.io/github/contributors/bsteubing/modular-lca?logo=GitHub) ![GitHub Repo stars](https://img.shields.io/github/stars/bsteubing/modular-lca?style=social)

| author | project source | project documentation |
| ------ | -------------- | --------------------- |
| [bsteubing](https://github.com/bsteubing) | [`modular-lca`](https://github.com/bsteubing/modular-lca) | [`GitHub readme`](https://github.com/bsteubing/modular-lca) |

An approach for modular LCA. Parts of lifecylces can be recombined in flexible ways. This can also be used to make lifecycle stages and simply calculate the environmental impact of these. A graphical user interface is very useful (but currently only a very early version of the Activity Browser contained this; a new interface may be added in the future).

0 comments on commit 19b81dc

Please sign in to comment.