Skip to main content

Package used to create balanced LCA water exchange samples to override unbalanced sample in Brightway2.

Project description

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.

The rescaling is done according to three different strategy, depending on the nature of the exchanges: * default: rescale sampled inputs so that mass ratio of sampled input to sampled output is same as in static activity
* inverse: rescale sampled outputs so that mass ratio of sampled input to sampled output is same as in static activity
* set_static: replace sampled exchanges with value in static activity

It was developped with ecoinvent in mind, though the modifications required to make it useful for other databases would be minimal.

pipeline status coverage report

Installation

Use the package manager pip to install bw2waterbalancer:

pip install bw2waterbalancer

or use conda:

conda install --channel pascallesage bw2waterbalancer

Usage

from bw2waterbalancer import DatabaseWaterBalancer
from brightway2 import projects

projects.set_current("my project")

dwb = DatabaseWaterBalancer(
    ecoinvent_version="3.6", # used to identify activities with water production exchanges
    database_name="ei36_cutoff", #name the LCI db in the brightway2 project
)

Validating data Getting information on technosphere water exchanges 0% [##############################] 100% | ETA: 00:00:00 Total time elapsed: 00:00:00 Getting information on biosphere water exchanges 0% [##############################] 100% | ETA: 00:00:00 Total time elapsed: 00:01:09

# Generate samples, and format as matrix_data for use in presamples
dwb.add_samples_for_all_acts(iterations=1000)

0% [##############################] 100% | ETA: 00:00:00 Total time elapsed: 00:18:11

# Create presamples package
dwb.create_presamples(
    name='some name', 
    dirpath=some/path, 
    id_='some id',
    seed='sequential', #or None, or int
    )

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Acknowledgment

Special thanks to Quantis US for having funded the early iterations of this work.

License

MIT

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

bw2waterbalancer-0.1.1.tar.gz (16.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bw2waterbalancer-0.1.1-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

Details for the file bw2waterbalancer-0.1.1.tar.gz.

File metadata

  • Download URL: bw2waterbalancer-0.1.1.tar.gz
  • Upload date:
  • Size: 16.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for bw2waterbalancer-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d0983781e24d2a171d977ef82e9fb419af29a78e2158e29ce628f79161866812
MD5 f8b28cfd9993d9106dcdae018dcaa8ba
BLAKE2b-256 e13259e926d66285b5fdfd69fa2518abf9fc82338911ca4306b22605be6bf90c

See more details on using hashes here.

File details

Details for the file bw2waterbalancer-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: bw2waterbalancer-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 18.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for bw2waterbalancer-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 53bbc09cc1edec0a1c77b687678cd2848164d6f7eb309e1015bef9d93a651149
MD5 2cce744b781d68af70e2f0e40651c30f
BLAKE2b-256 3fa4bf8c82a8c0d35ca1a04a3bdb2e324b089d71d53b0e4388edf6a1b75d2269

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page