mrvisscher / bw-scenarios

MIT License
5 stars 2 forks source link

bw-scenarios

This is a project for the BrightCon Hackathon 2024. We aim to move the scenario LCA functionalities from AB to BW25.

PyPI Status Python Version License

Read the documentation at https://bw-scenarios.readthedocs.io/ Tests Codecov

pre-commit Black

Installation

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

$ pip install bw_scenarios

Contributing

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

License

Distributed under the terms of the MIT license, _bwscenarios 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_bw-scenarios

and running the build command:

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