lca-algebraic-bw25 1.3__tar.gz

lca_algebraic_bw25-1.3/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2020, OIE - Mines ParisTech
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

lca_algebraic_bw25-1.3/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: lca_algebraic_bw25
+Version: 1.3
+Summary: This library provides a layer above brightway2 for defining parametric models and running super fast LCA for monte carlo analysis.
+Author-email: OIE - Mines ParisTech <raphael.jolivet@mines-paristech.fr>
+License: BSD
+Project-URL: Homepage, https://lca-algebraic.readthedocs.io/en/stable/
+Project-URL: Repository, https://github.com/oie-mines-paristech/lca_algebraic.git
+Project-URL: Documentation, https://lca-algebraic.readthedocs.io/
+Project-URL: Changelog, https://github.com/oie-mines-paristech/lca_algebraic/blob/main/RELEASE_NOTES.md
+Keywords: LCA,brightway2,monte-carlo,parametric
+Requires-Python: <3.13,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: tabulate
+Requires-Dist: ipywidgets
+Requires-Dist: pandas
+Requires-Dist: pyarrow
+Requires-Dist: seaborn
+Requires-Dist: sympy
+Requires-Dist: matplotlib
+Requires-Dist: deprecation
+Requires-Dist: brightway25
+Requires-Dist: SALib
+Requires-Dist: pint
+Requires-Dist: typing-extensions
+Requires-Dist: pypardiso; platform_machine == "x86_64"
+Dynamic: license-file
+
+
+
+<img src="./doc/source/_static/img/logo_lca_algebraic.png" alt="logo" width="200" style="margin:auto;display:block"/>
+
+
+![Python 3.10](https://img.shields.io/badge/python-3.10-blue) 
+![Python 3.11](https://img.shields.io/badge/python-3.11-blue)
+![Python 3.12](https://img.shields.io/badge/python-3.12-blue)
+
+[![Brightway 2.4](https://img.shields.io/badge/brightway-2.4-blue)](https://docs.brightway.dev/en/legacy/index.html)
+[![Brightway 2.5](https://img.shields.io/badge/brightway-2.5-blue)](https://docs.brightway.dev/en/latest/)
+
+**lca_algebraic** is a layer above [**Brightway**](https://brightway.dev/) designed for the definition of **parametric inventories** 
+with fast computation of LCA impacts, suitable for **monte-carlo** / global sensitivity analysis 
+
+It integrates the magic of [Sympy](https://www.sympy.org/en/index.html) in order to write parametric formulas as regular Python expressions.
+
+**lca-algebraic** provides a set of **helper functions** for : 
+* **compact** & **human readable** definition of activities :  
+    * search background (tech and biosphere) activities 
+    * create new foreground activities with parametrized amounts
+    * parametrize / update existing background activities (extending the class **Activity**)
+* Definition of parameters
+* Fast computation of LCAs
+* Computation of monte carlo method and global sensitivity analysis (Sobol indices) 
+* Support for automatic check of [homogeneity of physical units](https://lca-algebraic.readthedocs.io/en/stable/api/units.html)
+
+# ⚙ Installation
+
+We support both [Brightway 2.4 (legacy)](https://docs.brightway.dev/en/legacy/index.html)
+and [Brightway 2.5](https://docs.brightway.dev/en/latest/) via two separate branches / libraries :
+
+* [lca_algebraic](https://pypi.org/project/lca-algebraic/) (for Brightway 2.4)
+* [lca_algebraic_bw25](https://pypi.org/project/lca-algebraic/) (for  Brightway 2.5)
+
+## 1) Setup separate environment
+
+First create a python environment, with **Python** [>=3.10, <3.13] :
+
+**With Conda (or [mamba](https://mamba.readthedocs.io/en/latest/index.html))**
+
+```bash
+conda create -n lca python==3.10
+conda activate lca
+```
+
+**With virtual env**
+
+```bash
+python3.10 -m venv .venv
+source .venv/bin/activate
+```
+
+## 2) Install lca_algebraic
+
+> pip install lca_algebraic 
+
+Or, for brightway 25 :
+
+> pip install lca_algebraic_bw25
+
+## 3) [Optional] Install Jupyter & Activity Browser 
+
+You may also install Jupyter and [Activity Browser](https://github.com/LCA-ActivityBrowser/activity-browser) on the same 
+environment.
+
+**Jupyter** :
+> pip  install jupyter
+
+**Activity Browser** can only be installed via conda/mamba. Note that it can also be installed on a separate Python env and will 
+still be able to access and browse the projects created programmatically with *lca_algebraic* / *Brightway*.  
+> conda install activity-browser
+
+> **NOTE**
+> While the inventories created in *lca_algebraic* are stored in the Brightway project, 
+> the formulas and parameters are not compatible with **Activity Browser**
+> Before computing impacts with vanilla **Brightway2** or **Activity Browser**, 
+> you may use the function [freezeParams()](https://lca-algebraic.readthedocs.io/en/stable/api/parameters.html#lca_algebraic.freezeParams) 
+> to update the amounts in your database for a given scenario / set of parameter values.     
+
+
+
+# 📚 Documentation & resources
+
+Full documentation is [hosted on **readthedocs**](https://lca-algebraic.readthedocs.io/)
+
+We provide some notebooks :
+* [Example notebook](./notebooks/example-notebook.ipynb) : Basic functionalities  
+* [Handbook](./notebooks/handbook.ipynb) : More examples, also showing the usage of the Brightway functions.
+* [Workshop](https://git.sophia.mines-paristech.fr/oie/lca-algebraic-workshop) :
+  A "real life" exercise used as a short training on *lca_algebraic*
+
+# 📧 Mailing list
+
+Please register to this dedicated mailing list to discuss the evolutions of this library and be informed of future releases :
+
+[lca_algebraic@groupes.mines-paristech.fr](https://groupes.minesparis.psl.eu/wws/subscribe/lca_algebraic)
+
+
+# © Licence & Copyright
+
+This library has been developed by [MinesParis - PSL - O.I.E team](https://www.oie.minesparis.psl.eu/), for the project [*INCER-ACV*](https://librairie.ademe.fr/energies-renouvelables-reseaux-et-stockage/4448-incer-acv.html), 
+lead by [ADEME](https://www.ademe.fr/). 
+
+It is distributed under the [BSD License](./LICENSE)
+
+# Logo
+
+Please use the following logo to advertise about this librairy.
+![](./doc/source/_static/img/logo_lca_algebraic.png)

lca_algebraic_bw25-1.3/README.md

@@ -0,0 +1,110 @@
+
+
+<img src="./doc/source/_static/img/logo_lca_algebraic.png" alt="logo" width="200" style="margin:auto;display:block"/>
+
+
+![Python 3.10](https://img.shields.io/badge/python-3.10-blue) 
+![Python 3.11](https://img.shields.io/badge/python-3.11-blue)
+![Python 3.12](https://img.shields.io/badge/python-3.12-blue)
+
+[![Brightway 2.4](https://img.shields.io/badge/brightway-2.4-blue)](https://docs.brightway.dev/en/legacy/index.html)
+[![Brightway 2.5](https://img.shields.io/badge/brightway-2.5-blue)](https://docs.brightway.dev/en/latest/)
+
+**lca_algebraic** is a layer above [**Brightway**](https://brightway.dev/) designed for the definition of **parametric inventories** 
+with fast computation of LCA impacts, suitable for **monte-carlo** / global sensitivity analysis 
+
+It integrates the magic of [Sympy](https://www.sympy.org/en/index.html) in order to write parametric formulas as regular Python expressions.
+
+**lca-algebraic** provides a set of **helper functions** for : 
+* **compact** & **human readable** definition of activities :  
+    * search background (tech and biosphere) activities 
+    * create new foreground activities with parametrized amounts
+    * parametrize / update existing background activities (extending the class **Activity**)
+* Definition of parameters
+* Fast computation of LCAs
+* Computation of monte carlo method and global sensitivity analysis (Sobol indices) 
+* Support for automatic check of [homogeneity of physical units](https://lca-algebraic.readthedocs.io/en/stable/api/units.html)
+
+# ⚙ Installation
+
+We support both [Brightway 2.4 (legacy)](https://docs.brightway.dev/en/legacy/index.html)
+and [Brightway 2.5](https://docs.brightway.dev/en/latest/) via two separate branches / libraries :
+
+* [lca_algebraic](https://pypi.org/project/lca-algebraic/) (for Brightway 2.4)
+* [lca_algebraic_bw25](https://pypi.org/project/lca-algebraic/) (for  Brightway 2.5)
+
+## 1) Setup separate environment
+
+First create a python environment, with **Python** [>=3.10, <3.13] :
+
+**With Conda (or [mamba](https://mamba.readthedocs.io/en/latest/index.html))**
+
+```bash
+conda create -n lca python==3.10
+conda activate lca
+```
+
+**With virtual env**
+
+```bash
+python3.10 -m venv .venv
+source .venv/bin/activate
+```
+
+## 2) Install lca_algebraic
+
+> pip install lca_algebraic 
+
+Or, for brightway 25 :
+
+> pip install lca_algebraic_bw25
+
+## 3) [Optional] Install Jupyter & Activity Browser 
+
+You may also install Jupyter and [Activity Browser](https://github.com/LCA-ActivityBrowser/activity-browser) on the same 
+environment.
+
+**Jupyter** :
+> pip  install jupyter
+
+**Activity Browser** can only be installed via conda/mamba. Note that it can also be installed on a separate Python env and will 
+still be able to access and browse the projects created programmatically with *lca_algebraic* / *Brightway*.  
+> conda install activity-browser
+
+> **NOTE**
+> While the inventories created in *lca_algebraic* are stored in the Brightway project, 
+> the formulas and parameters are not compatible with **Activity Browser**
+> Before computing impacts with vanilla **Brightway2** or **Activity Browser**, 
+> you may use the function [freezeParams()](https://lca-algebraic.readthedocs.io/en/stable/api/parameters.html#lca_algebraic.freezeParams) 
+> to update the amounts in your database for a given scenario / set of parameter values.     
+
+
+
+# 📚 Documentation & resources
+
+Full documentation is [hosted on **readthedocs**](https://lca-algebraic.readthedocs.io/)
+
+We provide some notebooks :
+* [Example notebook](./notebooks/example-notebook.ipynb) : Basic functionalities  
+* [Handbook](./notebooks/handbook.ipynb) : More examples, also showing the usage of the Brightway functions.
+* [Workshop](https://git.sophia.mines-paristech.fr/oie/lca-algebraic-workshop) :
+  A "real life" exercise used as a short training on *lca_algebraic*
+
+# 📧 Mailing list
+
+Please register to this dedicated mailing list to discuss the evolutions of this library and be informed of future releases :
+
+[lca_algebraic@groupes.mines-paristech.fr](https://groupes.minesparis.psl.eu/wws/subscribe/lca_algebraic)
+
+
+# © Licence & Copyright
+
+This library has been developed by [MinesParis - PSL - O.I.E team](https://www.oie.minesparis.psl.eu/), for the project [*INCER-ACV*](https://librairie.ademe.fr/energies-renouvelables-reseaux-et-stockage/4448-incer-acv.html), 
+lead by [ADEME](https://www.ademe.fr/). 
+
+It is distributed under the [BSD License](./LICENSE)
+
+# Logo
+
+Please use the following logo to advertise about this librairy.
+![](./doc/source/_static/img/logo_lca_algebraic.png)

lca_algebraic_bw25-1.3/lca_algebraic/__init__.py

@@ -0,0 +1,42 @@
+#
+# This file defines several utility functions above brightway2 to be used by notebooks
+#
+
+from .activity import *
+from .base_utils import *
+from .database import *
+from .interpolation import *
+from .io import *
+from .lca import *
+from .log import *
+from .methods import *
+from .params import *
+from .settings import Settings
+from .stats import *
+from .units import *
+
+# Backport the test of pypardiso from bw2calc to emit a warning
+try:
+    from pypardiso import factorized, spsolve
+except ImportError:
+    from scipy.sparse.linalg import factorized, spsolve
+    from scipy.sparse.linalg._dsolve import linsolve
+
+    if not linsolve.useUmfpack:
+        logger.warn(
+            """
+        Did not findPypardisio or Umfpack. Matrix computation may be very slow.
+
+        If you are on an Intel architecture, please install pypardiso as explained in the docs :
+        https://docs.brightway.dev/en/latest/content/installation/index.html
+
+        > pip install pypardiso
+        or
+        > conda install pypardiso
+        """
+        )
+
+
+# Global print options
+np.set_printoptions(threshold=30)
+pd.options.display.float_format = "{:,g}".format