Metadata-Version: 2.5
Name: cheme-as-code-lci
Version: 0.1.0
Summary: Install the ChemE-as-Code Process Atlas LCI database into a Brightway 2.5 project, linked to your own background databases.
Author: ChemE-as-Code
License-Expression: MIT
License-File: LICENSE
Classifier: Private :: Do Not Upload
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: <3.15,>=3.12
Requires-Dist: bw2data>=4.0
Requires-Dist: bw2io>=0.9
Requires-Dist: openpyxl>=3.1
Provides-Extra: calc
Requires-Dist: bw2calc>=2.0; extra == 'calc'
Provides-Extra: multifunctional
Requires-Dist: multifunctional<2,>=1.1.2; extra == 'multifunctional'
Description-Content-Type: text/markdown

# cheme-as-code-lci

One-call import of the ChemE-as-Code Process Atlas LCI database (a bw2io Excel workbook built by
`scripts/build_lci.py`) into a Brightway 2.5 project, linked to the background databases you
are licensed for. See [`../lci/README.md`](../lci/README.md) for the modelling rules and caveats.

```python
import bw2data as bd
from cheme_as_code_lci import install

bd.projects.set_current("my-project")          # already holds ecoinvent and its biosphere
report = install("cheme-as-code-atlas-0.1.0.xlsx", background="ecoinvent-3.11-cutoff", location="FR")
print(report.summary())                        # every Atlas-to-Atlas link and the supply chains
```

An input that another Atlas process makes links to the Atlas market of its grade (delivered,
with transport and losses); `prefer_atlas="plant"` or `pin=["<activity code>"]` links it to the
plant gate instead, and `prefer_atlas=False` to your background.

The unallocated multi-output datasets (`cheme-as-code-atlas-<version>-multifunctional.json`)
install as a Brightway `multifunctional` database, whose allocation you choose (exergy, mass,
energy, price where stated, the build's share); with each process's default it reproduces the
workbook. Needs the extra: `pip install "./python[multifunctional]"`.

```python
from cheme_as_code_lci import install_multifunctional

report = install_multifunctional("lci/", background="ecoinvent-3.11-cutoff", location="FR")
```

## Licence

This package is under the [MIT License](LICENSE), so that you can use the data installer in any
workflow. The rest of the repository is not: see [`../NOTICE`](../NOTICE). The LCI database it
installs is under CC BY 4.0.
