diff --git a/README.md b/README.md index d7f1d28..c32e08f 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ and [`wurst`](https://github.com/polca/wurst) Python packages. without necessarily being LCA experts. On the other hand, `mescal` is also designed for LCA experts who want to integrate projections from ESM into their LCA studies. -![workflow of the mescal methodology](docs/pics/workflow.png "workflow") +![workflow of the mescal methodology](docs/pics/workflow_v2.png "workflow") Life-Cycle Inventory (LCI) datasets are taken from ecoinvent and possibly other sources if some of the ESM technologies are not covered in the ecoinvent database, e.g., [`premise`](https://linkinghub.elsevier.com/retrieve/pii/S136403212200226X) additional inventories. These LCI datasets are mapped diff --git a/docs/content/methods.md b/docs/content/methods.md index ba4e35f..6fa0e34 100644 --- a/docs/content/methods.md +++ b/docs/content/methods.md @@ -10,6 +10,8 @@ Modellers should provide a mapping between the technologies and resources in the LCI datasets can be regionalized to match the location of the ESM. For instance, if a LCI dataset does not exist for the region of interest, a new LCI dataset can be copied and adapted from an existing one (by changing the list of providers) as a proxy. If you are using a spatialized LCI database (i.e., with region-specific elementary flows), biosphere flows will be regionalized following the same procedure. +![flowchart of the regionalization algorithm](../pics/regionalization_flowchart.png "regionalization") + ## Double-counting removal Double-counting occurs regarding the flows that are explicitly modelled in the ESM, e.g., energy flows (electricity, heat, fuels, etc.). Such flows should be set to zero in the LCI datasets in order to avoid an overestimation of the impacts. The double-counting removal algorithm is as follows: diff --git a/docs/index.md b/docs/index.md index 482011c..5c9e302 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# _mescal_ +# `mescal` ```{button-link} https://docs.brightway.dev :color: info @@ -6,17 +6,17 @@ {octicon}`light-bulb;1em` mescal is a specialized package of the Brightway Software Framework ``` -## What is _mescal_? +## What is `mescal`? -_mescal_ is a Python package for the creation and management of life-cycle inventory databases and metrics derived from life-cycle assessment, to be integrated in decision-making tools such as energy system models. +`mescal` is a Python package for the creation and management of life-cycle inventory databases and metrics derived from life-cycle assessment, to be integrated in decision-making tools such as energy system models. -_mescal_ is a specialized package of the [Brightway Software Framework](https://brightway.dev/), mainly relying on the [bw2calc](https://github.com/brightway-lca/brightway2-calc) and [wurst](https://github.com/polca/wurst) Python packages. +`mescal` is a specialized package of the [Brightway Software Framework](https://brightway.dev/), mainly relying on the [bw2calc](https://github.com/brightway-lca/brightway2-calc) and [wurst](https://github.com/polca/wurst) Python packages. -_mescal_ was designed for all researchers and modellers aiming to include life-cycle assessment (LCA) in their work, but who are not necessarily LCA experts. _mescal_ is usually used within [Jupyter notebooks](https://jupyter.org/). +`mescal` was designed for all researchers and modellers aiming to include life-cycle assessment (LCA) in their work, but who are not necessarily LCA experts. `mescal` is usually used within [Jupyter notebooks](https://jupyter.org/). ## Workflow -![workflow of the mescal methodology](pics/workflow.png "workflow") +![workflow of the mescal methodology](pics/workflow_v2.png "workflow") LCI datasets are taken from ecoinvent and possibly other sources if some of the ESM technologies are not covered in the ecoinvent database, e.g., [_premise_](https://linkinghub.elsevier.com/retrieve/pii/S136403212200226X) additional inventories. These LCI datasets are mapped to the ESM technologies and resources. This is followed by operations of regionalization, databases harmonization, double-counting removal, and life-cycle impact assessment. LCA indicators are then ready to be integrated to the ESM. @@ -27,7 +27,7 @@ LCI datasets are taken from ecoinvent and possibly other sources if some of the ## Installation -You can install _mescal_ via [pip] from [PyPI]: +You can install `mescal` via [pip] from [PyPI]: ```console $ pip install mescal