You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[ ] Link this PR to related issues by using [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
21
+
22
+
#### If you have write access (otherwise a maintainer will do this for you):
17
23
-[ ] Categorize the PR by setting a good title and adding one of the labels:
-[ ] Link this PR to related issues by using [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
21
26
-[ ] Add a milestone to the PR (and related issues, if any) for the intended release.
The **Activity Browser (AB) is an open source software for Life Cycle Assessment (LCA)** that builds on [Brightway2](https://brightway.dev).
15
15
16
-
[Video tutorials](https://www.youtube.com/channel/UCsyySKrzEMsRFsWW1Oz-6aA/) are available on youtube.
17
-
18
-
Please also read and cite our [scientific paper](https://doi.org/10.1016/j.simpa.2019.100012).
19
-
20
-
21
16
### Some highlights
22
17
23
18
-**Fast LCA calculations**: for multiple reference flows, impact categories, and scenarios
24
19
-**A productivity tool for brightway**: model in brightway (python) and see the results in the AB or vice-versa
25
20
-**Advanced modeling:** Use parameters, scenarios (including prospective LCI databases from [premise](https://premise.readthedocs.io/en/latest/)), uncertainties and our Graph Explorer
26
21
-**Advanced analyses:** Contribution analyses, Sankey Diagrams, Monte Carlo, and Global Sensitivity Analysis
22
+
-**Plugins:** Extend the functionality of Activity Browser with
You can install and start the activity-browser like this:
50
-
51
-
```bash
52
-
conda create -n ab -c conda-forge --solver libmamba activity-browser
53
-
conda activate ab
54
-
activity-browser
55
-
```
56
-
57
-
### Mamba
58
-
59
-
You can also install the AB using [Mamba](https://mamba.readthedocs.io/en/latest/mamba-installation.html#mamba-install):
60
-
61
-
```bash
62
-
mamba create -n ab activity-browser
63
-
mamba activate ab
64
-
activity-browser
65
-
```
66
-
67
-
## The thorough way
68
-
### Conda
69
-
70
-
We recommend that you use **conda** to manage your python installation. You can install [Anaconda](https://www.anaconda.com/products/individual) or the more compact [miniconda](https://conda.io/miniconda.html) (Python 3 version) for your operating system. Installation instructions for miniconda can be found [here](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html). See also the [conda user guide](https://docs.conda.io/projects/conda/en/latest/user-guide/index.html) or the [Conda cheat sheet](https://docs.conda.io/projects/conda/en/latest/_downloads/843d9e0198f2a193a3484886fa28163c/conda-cheatsheet.pdf).
71
-
72
-
Skip this step if you already have a working installation of anaconda or miniconda, but make sure to keep your conda installation up-to-date: `conda update -n base conda`.
wiki page for a step-by-step guide to installing Activity Browser.
73
39
74
-
### Add the Conda-Forge channel
75
-
The activity-browser has many dependencies that are managed by the [conda-forge](https://conda.io/docs/user-guide/tasks/manage-channels.html) channel. Open a cmd-window or terminal (in Windows you may have to use the Anaconda prompt) and type the following:
76
-
77
-
```bash
78
-
conda config --prepend channels conda-forge
79
-
```
80
-
Also configure conda to use the libmamba solver which is significantly faster than the default.
81
-
```bash
82
-
conda config --set solver libmamba
83
-
```
84
-
85
-
### Installing Activity Browser
40
+
## The quick way
41
+
Or you can install and start the activity-browser like this:
86
42
87
43
```bash
88
44
conda create -n ab -c conda-forge activity-browser
89
45
conda activate ab
90
46
activity-browser
91
47
```
92
48
93
-
#### Activity Browser is installed
94
-
95
-
At this point the activity-browser and all of its dependencies will be installed in a new conda environment called `ab`. You can change the environment name `ab` to whatever suits you.
96
-
97
-
## Updating the AB
98
-
99
-
We recommend to regularly update the AB to receive new features & bugfixes. These commands will update the activity-browser and all of its dependencies in the conda environment called `ab`.
100
-
101
-
```bash
102
-
conda activate ab
103
-
conda update activity-browser
104
-
```
105
-
106
-
# Getting started
107
-
108
-
## Running the AB
109
-
110
-
First activate the environment where the activity browser is installed:
111
-
112
-
```bash
113
-
conda activate ab
114
-
```
115
-
116
-
Then simply run `activity-browser` and the application will open.
117
-
118
-
## Importing LCI databases
119
-
120
-
- In the `Project`-tab there is initially a button called _"Add default data (biosphere flows and impact categories)"_. Click this button to add the default data. This is equivalent to `brightway2.bw2setup()` in python.
121
-
- After adding the default data, you can import a database with the _"Import Database"_-Button. Follow the instructions of the database import wizard. Imports can be done in several ways:
122
-
- Directly from the ecoinvent homepage (ecoinvent login credentials required)
123
-
- From a 7zip archive
124
-
- From a directory with ecospold2 files (same as in brightway2)
125
-
- From Excel files using the brightway Excel format
- The AB has two mailing lists, for [updates](https://brightway.groups.io/g/AB-updates) and [user exchange](https://brightway.groups.io/g/AB-discussion)
135
-
-[Brightway2](https://brightway.dev/)
136
-
-[Global Sensitiviy Analysis paper](https://onlinelibrary.wiley.com/doi/10.1111/jiec.13194) describing GSA as implemented in the AB; see also our [wiki](https://github.com/LCA-ActivityBrowser/activity-browser/wiki/Global-Sensitivity-Analysis)
137
-
-[Modular LCA paper](https://link.springer.com/article/10.1007/s11367-015-1015-3); [documentation modular LCA](http://activity-browser.readthedocs.io/en/latest/index.html); re-implementation of modular LCA into the AB is [ongoing](https://github.com/marc-vdm/activity-browser/tree/mLCA)
| Plugins are not necessarily developed by Activity Browser maintainers. Below are listed plugins from people we trust but we do not check plugins code. **Use them at your own risk**. |
143
-
| The plugin system is still in development so keep in mind that things may change at any point. |
144
-
145
-
Since the `2.8 release` a plugin system has been added to the AB. Plugins are a flexible way to add new functionalities to the AB without modifying the software itself.
146
-
147
-
The plugin code has been designed and written by Remy le Calloch (supported by [G-SCOP laboratories](https://g-scop.grenoble-inp.fr/en/laboratory/g-scop-laboratory)) with revisions from the AB-team.
148
-
149
-
150
-
## Available plugins
151
-
152
-
These are the plugins that we know about. To add your plugin to this list either open an issue, or a pull request. All submitted plugins will be reviewed, although all risks associated with their use shall be born by the user.
153
-
154
-
| Name | Description | Links | Author(s) |
155
-
|:---------|-------------|-------|-----------|
156
-
|[ScenarioLink](https://github.com/polca/ScenarioLink)| Enables you to seamlessly fetch and reproduce scenario-based LCA databases, such as those generated by [premise](https://github.com/polca/premise)|[anaconda](https://anaconda.org/romainsacchi/ab-plugin-scenariolink), [pypi](https://pypi.org/project/ab-plugin-scenariolink/), [github](https://github.com/polca/ScenarioLink)| Romain Sacchi & Marc van der Meide |
157
-
|[ReSICLED](https://github.com/Pan6ora/ab-plugin-ReSICLED)| Evaluating the recyclability of electr(on)ic product for improving product design |[anaconda](https://anaconda.org/pan6ora/ab-plugin-resicled), [github](https://github.com/Pan6ora/ab-plugin-ReSICLED)| G-SCOP Laboratory |
158
-
|[Notebook](https://github.com/Pan6ora/ab-plugin-Notebook)| Use Jupyter notebooks from AB |[anaconda](https://anaconda.org/pan6ora/ab-plugin-template), [github](https://github.com/Pan6ora/ab-plugin-Notebook)| Rémy Le Calloch |
159
-
|[template](https://github.com/Pan6ora/activity-browser-plugin-template)| An empty plugin to start from |[anaconda](https://anaconda.org/pan6ora/ab-plugin-template), [github](https://github.com/Pan6ora/activity-browser-plugin-template)| Rémy Le Calloch |
160
-
161
-
## Installation
162
-
163
-
### detailed instructions
164
-
165
-
Every plugin's Github page (links are provided in the above table) should have a **Get this plugin** section with installation instructions.
166
-
167
-
### general instructions
168
-
169
-
Plugins are conda packages (like the Activity Browser). To add a plugin simply install it in your conda environment from the Anaconda repos.
170
-
171
-
_Nb: add `-c conda-forge` to the install command like below to avoid problems with dependencies._
Once a new plugin is installed restart the Activity Browser.
183
-
184
-
### enabling a plugin
185
-
186
-
Plugins are enabled **per-project**. Simply open the plugin manager in the `Tools > Plugins` menu.
187
-
188
-
Close the plugin manager. New tabs should have appeared in the AB (each plugin can spawn one tab on each left/right panel).
189
-
190
-
### disabling a plugin
191
-
192
-
Disable a plugin the same way you activated it.
193
-
194
-
**:warning: Keep in mind that all data created by the plugin in a project could be erased when you disable it.**
195
-
196
-
## Development
197
-
198
-
The best place to start to create new plugins is the [plugin template](https://github.com/Pan6ora/activity-browser-plugin-template). Its code and README will help you to understand how to create a plugin.
0 commit comments