bw-superstructure
allows prospective LCA calculations for scenarios using the superstructure and scenario-difference-file approach of the activity-browser and brightway2
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in README -
✓Academic publication links
Links to: springer.com -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.2%) to scientific vocabulary
Keywords
Repository
allows prospective LCA calculations for scenarios using the superstructure and scenario-difference-file approach of the activity-browser and brightway2
Basic Info
Statistics
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 2
Topics
Metadata Files
README.md
bw_superstructure
Contents
Introduction
The brightway-superstructure library allows to conduct scenario LCA calculations using the approach of the superstructure, as it has been developed for the activity-browser (AB).
Installation
First install python 3.10 and pip.
If you use conda-forge, please add the channels bsteubing and cmutel for the brightway dependencies.
For installation via pip use:
console
pip install bw-superstructure
To install from git source use hatch:
console
pip install hatch
hatch build
pip install -I .\dist\bw_superstructure-1.0.1-py3-none-any.whl
If you would like to have another version, replace 1.0.1 with the desired version number.
Features
- relinking a database (DB) from one to another (background-) DB
- creating a user-defined calculation set-up for several functional units and impact categories
- calculating scenario LCA scores with a superstructure and a scenario-difference-file
- exporting the LCA scores for the scenarios for each functional unit to an excel workbook
These features are illustrated in an example.
Requirements
- a working brightway2-project with databases
- functional units specified in an excel file (see inputs in example-folder) or in a list
- impact categories specified in a yaml file (see inputs in example-folder)
Required for scenario calculations: - a superstructure database (e.g. generated by premise) - a scenario difference file (SDF) (excel file, same format as for the AB, see provided template)
Features missing so far
- specifying a value for the functional units (so far, the amount is set to 1 by default for each functional unit)
- contribution analyses
- monte carlo analysis
- using several scenario difference files for the LCA calculation
Relation to the activity-browser (AB)
The code in this repository is mainly extracted from the activity-browser. The following AB version was used:
- version: 2022.11.16
- branch: activity-browser-dev
The extraction of code was conducted as follows: - original objects and functions from the AB are in the sub-modules bwutils and superstructure - each file has the original filename as in the AB - in the header of the file, the relative path for that file within the AB is given - each function or objects states the source of the AB and whether it has been adapted or not - all of the objects are original, unless otherwise stated, apart from the functions in the superstructure.manager, which defines functions which originally where methods of the class SuperstructureManager of the ab - search for "Note: source" to see all objects from the activity-browser - search for "adaptations:" to see the adaptations. no adaptations are mentioned, no adaptations were done
License
bw-superstructure is distributed under the terms of the LGPL-3.0 license.
The license for the data in the example is CC-BY-4.0.
Contribution
If you would like to contribute to bw-superstructure, please read, sign and send the Contributors License Agreement (CLA) to Carina Harpprecht.
When contributing to this repository, please discuss the changes you would like to make via issue, email, or any other method with the owners of this repository before making a change.
The library of bw-superstructure will be provided as-is in its current release version.
Minor bugs will be fixed in the future, but currently, no major support can be offered to the software.
However, feel free to get in touch in case you have any questions or would like to contribute.
Contact
- Carina Harpprecht: carina.harpprecht@dlr.de
Owner
- Name: dlr-ve-esy
- Login: dlr-ve-esy
- Kind: organization
- Repositories: 1
- Profile: https://github.com/dlr-ve-esy
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Harpprecht
given-names: Carina
orcid: https://orcid.org/0000-0002-2878-0139
- family-names: Fuchs
given-names: Benjamin
orcid: https://orcid.org/0000-0002-7820-851X
title: "bw-superstructure"
version: 1.0.1
identifiers:
- type: doi
value: 10.5281/zenodo.11199475
date-released: 2024-05-15
GitHub Events
Total
- Watch event: 1
Last Year
- Watch event: 1
Packages
- Total packages: 1
-
Total downloads:
- pypi 24 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 3
- Total maintainers: 1
pypi.org: bw-superstructure
allows prospective LCA calculations for scenarios using the superstructure and scenario-difference-file approach of the activity-browser and brightway2
- Documentation: https://github.com/dlr-ve-esy/bw_superstructure/blob/main/README.md
- License: lgpl-3.0
-
Latest release: 1.0.2
published 7 months ago
Rankings
Maintainers (1)
Dependencies
- brightway2 ==2.4
- bw2analyzer ==0.10
- bw2calc ==1.8.1
- bw2data ==3.6.5
- bw2io ==0.8.6
- bw2parameters ==0.7
- bw_migrations ==0.1
- hatch ==1.6
- pyarrow ==11.0
- ruamel.yaml ==0.17