README.md

elec_lca

Installation

You can install elec_lca via [pip] from [PyPI]:

$ pip install elec_lca

Objective

To transform a whole background ecoinvent database (tested with v3.9.1 cutoff) through user-specified electricity market mix for a certain location, for user-defined scenario(s) and periods.

Documentation

https://elec_lca.readthedocs.io/en/latest/

Requirement

Users need to provide their own background database, the ecoinvent database is not included in this package.

Required packages are given in requirements.txt Run the following commands to install the package:

git clone https://github.com/alexrob18/elec_lca.git
cd elec_lca (or your local repo path)
pip install -r requirements.txt

How to use it

The best way is to follow the example notebook in the example folder.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the Apache 2.0 license, elec_lca is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Building the Documentation

You can build the documentation locally by installing the documentation Conda environment:

conda env create -f docs/environment.yml

activating the environment

conda activate sphinx_elec_lca

and running the build command:

sphinx-build docs _build/html --builder=html --jobs=auto --write-all; open _build/html/index.html