lca_supplymat 0.1.3__tar.gz

lca_supplymat-0.1.3/.gitignore

@@ -0,0 +1,20 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+
+# Build artifacts
+dist/
+build/
+
+# Test / runtime data
+data/
+.cache/
+
+# Notebook checkpoints
+.ipynb_checkpoints/
+
+# IDE
+.idea/
+*.pypi.md

lca_supplymat-0.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Raphaël JOLIVET, Joanna SCHLESINGER-MARTINAT
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

lca_supplymat-0.1.3/Makefile

@@ -0,0 +1,8 @@
+.PHONY: build publish
+
+build:
+	.venv/bin/python scripts/preprocess_readme.py
+	uv build --out-dir dist
+
+publish: build
+	uv publish --index pypi

lca_supplymat-0.1.3/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.5
+Name: lca_supplymat
+Version: 0.1.3
+Summary: Calculate material-related metrics from Life Cycle Inventory data via a Brightway LCIA method.
+Project-URL: Homepage, https://git.sophia.minesparis.psl.eu/oie/acv/lca-supplymat
+Project-URL: Source, https://git.sophia.minesparis.psl.eu/oie/acv/lca-supplymat
+Author: Raphaël JOLIVET, Joanna SCHLESINGER-MARTINAT
+License: MIT License
+        
+        Copyright (c) 2026 Raphaël JOLIVET, Joanna SCHLESINGER-MARTINAT
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: brightway25>=1.1.1
+Requires-Dist: ipykernel>=7.3.0
+Requires-Dist: ipywidgets>=8.1.9
+Requires-Dist: pypardiso>=0.4.7
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: rich>=15.0.0
+Provides-Extra: test
+Requires-Dist: pytest>=8; extra == 'test'
+Requires-Dist: tox>=4; extra == 'test'
+Description-Content-Type: text/markdown
+
+# lca_supplymat
+
+A [Brightway](https://brightway.dev/) Life Cycle Impact Assessment (LCIA) method that computes the **amount of manufactured materials** (copper, concrete, steel, aluminium, …) directly from Life Cycle Inventory (LCI) data.
+
+## Intro
+
+Impact indicators related to material depletion, criticality or circularity are notoriously complex to interpret. `lca-supplymat` exposes a simpler, physical metric: the **quantity of manufactured material** required by an inventory. Instead of weighing environmental impact, it counts how much of a given material (e.g. copper or steel) is embedded in the activities of a life cycle.
+
+This library implements this as a standard Brightway LCIA method, so it benefits from the full range of Brightway functionalities (MultiLCA, Monte-Carlo, parameterization, etc.). For each material, a pseudo-biosphere flow is added to the activities that produce it, and the method computes the **net production** of the material — the difference between what an activity outputs and what it consumes of the same material upstream. This avoids double counting between the production and market stages. One LCIA method is registered per material.
+
+The approach was tested with ecoinvent 3.11 (cutoff and attributional system models). It is comparable in spirit to the [Edges](https://github.com/romainsacchi/EDGES_CA) library, but implemented natively within the Brightway framework.
+
+## Installation
+
+```bash
+pip install lca_supplymat
+```
+
+**Prerequisites** :
+* A **Python>3.12** environement
+* **Brightway 25** (will be installed if not found)
+* A Brightway project with ecoinvent background database  
+
+## Usage
+
+### Setup of the methods
+
+```python
+from lca_supplymat import setup_lca_supply_mat, cleanup
+
+setup_lca_supply_mat(
+    target_db="ecoinvent-3.11-cutoff",
+    yaml_file="path.yaml",      # optionnal: load 23 definition from the package by default 
+    subset=["concrete"],        # optional: install only these definitions
+    out_folder="data/out",      # optional: write a CSV report per material
+    check_impacts=True,         # optional: verify impact scores are ~1
+    cleanup_before=True,        # optional: reset existing material methods first
+)
+```
+
+What it does:
+
+- creates a dedicated Brightway database `lca_supplymat` holding the pseudo-biosphere "counting" flows;
+- computes the net production of each requested material for every matching activity and adds the corresponding exchanges;
+- registers one Brightway `Method` per material, keyed as `("lca_supplymat", "total", "<material>")`.
+
+Once the setup is done, you can use the new methods as regular LCIA methods in Brightway / Activity Browser.
+
+To tear the material methods down again:
+
+```python
+cleanup("ecoinvent-3.11-cutoff")
+```
+
+## Material definitions
+
+By default, the 23 definitions of material methods are installed : 
+See [materials_methods.yaml](https://git.sophia.minesparis.psl.eu/oie/acv/lca-supplymat/-/blob/main/lca_supplymat/res/materials_methods.yaml)
+
+## Writing your own definitions
+
+You can provide your own definitions by passing the `yaml_file` parameter. 
+
+The file maps a definition key to a set of matching rules:
+
+```yaml
+copper:
+  matchings: ["copper, cathode*", "copper, anode*"]
+  excludes: ["*scrap*"]      # optional: patterns that veto a match
+  unit: kilogram
+  tolerance: 0.05            # optional: allowed deviation for the impact check (default 0.05)
+```
+
+- **`matchings`** (required): a list of patterns used to select activities.
+- **`excludes`** (optional): a list of patterns; if any matches, the activity is rejected.
+- **`unit`** (required): the unit the matching activities must be in.
+- **`tolerance`** (optional): allowed deviation of the impact score from 1 during the `check_impacts` step (default `0.05`).
+
+**Matching semantics.** Matching is performed against an activity's **reference product name** (`act["reference product"]`), and the activity's unit must equal the definition's `unit`. A pattern containing `*` acts as a **prefix wildcard** (`"steel*"` matches any reference product starting with `steel`); a pattern without `*` must be an **exact match**. `excludes` follows the same wildcard rules and overrides any `matchings` hit.
+
+Then pass your file to the setup:
+
+```python
+setup_lca_supply_mat(
+    target_db="ecoinvent-3.11-cutoff",
+    yaml_file="path/to/my_definitions.yaml")
+```
+
+## Example
+
+See the [demo notebook](https://git.sophia.minesparis.psl.eu/oie/acv/lca-supplymat/-/blob/main/notebook.ipynb) for a complete, runnable example.
+
+## License
+
+[MIT](https://git.sophia.minesparis.psl.eu/oie/acv/lca-supplymat/-/blob/main/LICENSE)
+
+## Authors
+
+- [Raphaël JOLIVET](https://orcid.org/0000-0001-7149-5010)
+- [Joanna SCHLESINGER-MARTINAT](https://orcid.org/0009-0006-0419-0990)
+
+Organisation : [OIE | Mines Paris |  PSL](https://ror.org/054fae424)

lca_supplymat-0.1.3/README.md

@@ -0,0 +1,102 @@
+# lca_supplymat
+
+A [Brightway](https://brightway.dev/) Life Cycle Impact Assessment (LCIA) method that computes the **amount of manufactured materials** (copper, concrete, steel, aluminium, …) directly from Life Cycle Inventory (LCI) data.
+
+## Intro
+
+Impact indicators related to material depletion, criticality or circularity are notoriously complex to interpret. `lca-supplymat` exposes a simpler, physical metric: the **quantity of manufactured material** required by an inventory. Instead of weighing environmental impact, it counts how much of a given material (e.g. copper or steel) is embedded in the activities of a life cycle.
+
+This library implements this as a standard Brightway LCIA method, so it benefits from the full range of Brightway functionalities (MultiLCA, Monte-Carlo, parameterization, etc.). For each material, a pseudo-biosphere flow is added to the activities that produce it, and the method computes the **net production** of the material — the difference between what an activity outputs and what it consumes of the same material upstream. This avoids double counting between the production and market stages. One LCIA method is registered per material.
+
+The approach was tested with ecoinvent 3.11 (cutoff and attributional system models). It is comparable in spirit to the [Edges](https://github.com/romainsacchi/EDGES_CA) library, but implemented natively within the Brightway framework.
+
+## Installation
+
+```bash
+pip install lca_supplymat
+```
+
+**Prerequisites** :
+* A **Python>3.12** environement
+* **Brightway 25** (will be installed if not found)
+* A Brightway project with ecoinvent background database  
+
+## Usage
+
+### Setup of the methods
+
+```python
+from lca_supplymat import setup_lca_supply_mat, cleanup
+
+setup_lca_supply_mat(
+    target_db="ecoinvent-3.11-cutoff",
+    yaml_file="path.yaml",      # optionnal: load 23 definition from the package by default 
+    subset=["concrete"],        # optional: install only these definitions
+    out_folder="data/out",      # optional: write a CSV report per material
+    check_impacts=True,         # optional: verify impact scores are ~1
+    cleanup_before=True,        # optional: reset existing material methods first
+)
+```
+
+What it does:
+
+- creates a dedicated Brightway database `lca_supplymat` holding the pseudo-biosphere "counting" flows;
+- computes the net production of each requested material for every matching activity and adds the corresponding exchanges;
+- registers one Brightway `Method` per material, keyed as `("lca_supplymat", "total", "<material>")`.
+
+Once the setup is done, you can use the new methods as regular LCIA methods in Brightway / Activity Browser.
+
+To tear the material methods down again:
+
+```python
+cleanup("ecoinvent-3.11-cutoff")
+```
+
+## Material definitions
+
+By default, the 23 definitions of material methods are installed : 
+See [materials_methods.yaml](lca_supplymat/res/materials_methods.yaml)
+
+## Writing your own definitions
+
+You can provide your own definitions by passing the `yaml_file` parameter. 
+
+The file maps a definition key to a set of matching rules:
+
+```yaml
+copper:
+  matchings: ["copper, cathode*", "copper, anode*"]
+  excludes: ["*scrap*"]      # optional: patterns that veto a match
+  unit: kilogram
+  tolerance: 0.05            # optional: allowed deviation for the impact check (default 0.05)
+```
+
+- **`matchings`** (required): a list of patterns used to select activities.
+- **`excludes`** (optional): a list of patterns; if any matches, the activity is rejected.
+- **`unit`** (required): the unit the matching activities must be in.
+- **`tolerance`** (optional): allowed deviation of the impact score from 1 during the `check_impacts` step (default `0.05`).
+
+**Matching semantics.** Matching is performed against an activity's **reference product name** (`act["reference product"]`), and the activity's unit must equal the definition's `unit`. A pattern containing `*` acts as a **prefix wildcard** (`"steel*"` matches any reference product starting with `steel`); a pattern without `*` must be an **exact match**. `excludes` follows the same wildcard rules and overrides any `matchings` hit.
+
+Then pass your file to the setup:
+
+```python
+setup_lca_supply_mat(
+    target_db="ecoinvent-3.11-cutoff",
+    yaml_file="path/to/my_definitions.yaml")
+```
+
+## Example
+
+See the [demo notebook](notebook.ipynb) for a complete, runnable example.
+
+## License
+
+[MIT](LICENSE)
+
+## Authors
+
+- [Raphaël JOLIVET](https://orcid.org/0000-0001-7149-5010)
+- [Joanna SCHLESINGER-MARTINAT](https://orcid.org/0009-0006-0419-0990)
+
+Organisation : [OIE | Mines Paris |  PSL](https://ror.org/054fae424)

lca_supplymat-0.1.3/README.pypi.md

@@ -0,0 +1,102 @@
+# lca_supplymat
+
+A [Brightway](https://brightway.dev/) Life Cycle Impact Assessment (LCIA) method that computes the **amount of manufactured materials** (copper, concrete, steel, aluminium, …) directly from Life Cycle Inventory (LCI) data.
+
+## Intro
+
+Impact indicators related to material depletion, criticality or circularity are notoriously complex to interpret. `lca-supplymat` exposes a simpler, physical metric: the **quantity of manufactured material** required by an inventory. Instead of weighing environmental impact, it counts how much of a given material (e.g. copper or steel) is embedded in the activities of a life cycle.
+
+This library implements this as a standard Brightway LCIA method, so it benefits from the full range of Brightway functionalities (MultiLCA, Monte-Carlo, parameterization, etc.). For each material, a pseudo-biosphere flow is added to the activities that produce it, and the method computes the **net production** of the material — the difference between what an activity outputs and what it consumes of the same material upstream. This avoids double counting between the production and market stages. One LCIA method is registered per material.
+
+The approach was tested with ecoinvent 3.11 (cutoff and attributional system models). It is comparable in spirit to the [Edges](https://github.com/romainsacchi/EDGES_CA) library, but implemented natively within the Brightway framework.
+
+## Installation
+
+```bash
+pip install lca_supplymat
+```
+
+**Prerequisites** :
+* A **Python>3.12** environement
+* **Brightway 25** (will be installed if not found)
+* A Brightway project with ecoinvent background database  
+
+## Usage
+
+### Setup of the methods
+
+```python
+from lca_supplymat import setup_lca_supply_mat, cleanup
+
+setup_lca_supply_mat(
+    target_db="ecoinvent-3.11-cutoff",
+    yaml_file="path.yaml",      # optionnal: load 23 definition from the package by default 
+    subset=["concrete"],        # optional: install only these definitions
+    out_folder="data/out",      # optional: write a CSV report per material
+    check_impacts=True,         # optional: verify impact scores are ~1
+    cleanup_before=True,        # optional: reset existing material methods first
+)
+```
+
+What it does:
+
+- creates a dedicated Brightway database `lca_supplymat` holding the pseudo-biosphere "counting" flows;
+- computes the net production of each requested material for every matching activity and adds the corresponding exchanges;
+- registers one Brightway `Method` per material, keyed as `("lca_supplymat", "total", "<material>")`.
+
+Once the setup is done, you can use the new methods as regular LCIA methods in Brightway / Activity Browser.
+
+To tear the material methods down again:
+
+```python
+cleanup("ecoinvent-3.11-cutoff")
+```
+
+## Material definitions
+
+By default, the 23 definitions of material methods are installed : 
+See [materials_methods.yaml](https://git.sophia.minesparis.psl.eu/oie/acv/lca-supplymat/-/blob/main/lca_supplymat/res/materials_methods.yaml)
+
+## Writing your own definitions
+
+You can provide your own definitions by passing the `yaml_file` parameter. 
+
+The file maps a definition key to a set of matching rules:
+
+```yaml
+copper:
+  matchings: ["copper, cathode*", "copper, anode*"]
+  excludes: ["*scrap*"]      # optional: patterns that veto a match
+  unit: kilogram
+  tolerance: 0.05            # optional: allowed deviation for the impact check (default 0.05)
+```
+
+- **`matchings`** (required): a list of patterns used to select activities.
+- **`excludes`** (optional): a list of patterns; if any matches, the activity is rejected.
+- **`unit`** (required): the unit the matching activities must be in.
+- **`tolerance`** (optional): allowed deviation of the impact score from 1 during the `check_impacts` step (default `0.05`).
+
+**Matching semantics.** Matching is performed against an activity's **reference product name** (`act["reference product"]`), and the activity's unit must equal the definition's `unit`. A pattern containing `*` acts as a **prefix wildcard** (`"steel*"` matches any reference product starting with `steel`); a pattern without `*` must be an **exact match**. `excludes` follows the same wildcard rules and overrides any `matchings` hit.
+
+Then pass your file to the setup:
+
+```python
+setup_lca_supply_mat(
+    target_db="ecoinvent-3.11-cutoff",
+    yaml_file="path/to/my_definitions.yaml")
+```
+
+## Example
+
+See the [demo notebook](https://git.sophia.minesparis.psl.eu/oie/acv/lca-supplymat/-/blob/main/notebook.ipynb) for a complete, runnable example.
+
+## License
+
+[MIT](https://git.sophia.minesparis.psl.eu/oie/acv/lca-supplymat/-/blob/main/LICENSE)
+
+## Authors
+
+- [Raphaël JOLIVET](https://orcid.org/0000-0001-7149-5010)
+- [Joanna SCHLESINGER-MARTINAT](https://orcid.org/0009-0006-0419-0990)
+
+Organisation : [OIE | Mines Paris |  PSL](https://ror.org/054fae424)

lca_supplymat-0.1.3/lca_supplymat/__init__.py

@@ -0,0 +1,2 @@
+from .main import setup_lca_supply_mat, cleanup, list_methods_available_methods
+from .settings import *