Activity Browser plugin to download scenario-based LCA databases
Project description
# ScenarioLink: An Activity Browser Plugin for Scenario-Based LCA Databases
ScenarioLink is a specialized plugin for the [Activity Browser](https://github.com/LCA-ActivityBrowser/activity-browser), an open-source software for Life Cycle Assessment (LCA). This plugin enables you to seamlessly fetch and reproduce scenario-based LCA databases, such as those generated by [premise](https://github.com/polca/premise), using [unfold](https://github.com/polca/unfold) datapackages.
## Features
Reproduce individual or multiple scenario-based databases within Activity Browser.
Merge multiple databases into a unified superstructure database containing various scenarios.
Leverage the capabilities of the unfold library to recreate databases with the necessary scaling factors.
## Overview
The Activity Browser builds upon the [Brightway2](https://brightway.dev) LCA framework. ScenarioLink aims to simplify the use of scenario-based LCA databases within the Activity Browser by:
Eliminating the need for separate tools required to generate these databases (e.g., premise).
Utilizing unfold datapackages that contain scaling factors essential for reproducing scenario-based LCA databases, assuming a consistent source database (e.g., ecoinvent 3.7.1).
![Flow Diagram](assets/flow_diagram.png)
## Requirements
activty-browser >= 2.9.7, < 2.10.0
## Installation
Activate your existing Activity Browser conda environment.
Install the ScenarioLink plugin using conda (preferred) or Pypi (may create conflicts with activity-browser dependencies):
`bash conda install -c romainsacchi ab-plugin-scenariolink `
or
`bash pip install ab-plugin-scenariolink `
Launch the Activity Browser.
Navigate to Tools > Plugins and select ScenarioLink from the plugin list.
## Usage
### Reproduce a scenario-based database
Activate the plugin by selecting it from the plugin list.
![Plugin List](assets/plugin_list.png)
After activating the plugin, select the ScenarioLink tab.
![ScenarioLink Tab](assets/scenariolink_tab.png)
Select (double-click) the desired datapackage from the table.
![Datapackage Table](assets/datapackage_table.png)
If the datapackage selected is not present in the local cache, it will be downloaded from the remote repository.
Once the download is complete, a second table presents the scenarios contained in the datapackage.
![Scenario Table](assets/scenario_table.png)
Select the desired scenario(s) by checking the corresponding checkboxes.
Choose whether to merge the selected scenarios into a single database (superstructure database) or reproduce them individually.
Click Import to start the process.
The plugin will ask you to select the databases in your project that will be used as source databases.
![Source Database Selection](assets/source_database_selection.png)
The plugin will then reproduce the selected scenario(s) and add them to your project.
## Contributing
You can make your own scenario-based LCA databases available to the community. To do so, you need to create a unfold datapackage and upload it to a remote repository. We will then add it to the list of available datapackages in the ScenarioLink plugin.
## Maintainers
For questions, issues, or contributions, you can reach out to:
Marc van der Meide: [Email](mailto:m.t.van.der.meide@cml.leidenuniv.nl)
Romain Sacchi: [Email](mailto:romain.sacchi@psi.ch)
Alternatively, you can open an issue on this GitHub repository.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ab_plugin_scenariolink-0.1.0.tar.gz
.
File metadata
- Download URL: ab_plugin_scenariolink-0.1.0.tar.gz
- Upload date:
- Size: 20.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d9c88d331dbc8c629d799aa153ae747cce8df5f787dfd052150d0d6bcf3247e |
|
MD5 | e6668176f8e3951f57966f16cc33f6d4 |
|
BLAKE2b-256 | 5434be94755795fa71e77c8f5a4e037da4359b03524933b7d243568f692d5bc2 |
File details
Details for the file ab_plugin_scenariolink-0.1.0-py3-none-any.whl
.
File metadata
- Download URL: ab_plugin_scenariolink-0.1.0-py3-none-any.whl
- Upload date:
- Size: 20.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb7153ae38b2292a2265621fc634f595c792fb1addc1f425df5a0e5ff1e2f928 |
|
MD5 | 8536baa9b61910d0580b3ef2073dd437 |
|
BLAKE2b-256 | d0e870b2c378185b8465f04eb7a6a03ea8ced5d1a1ea16aef6594099a0d24062 |