premise 1.8.2.dev0__tar.gz → 1.8.2.dev2__tar.gz

{premise-1.8.2.dev0 → premise-1.8.2.dev2}/MANIFEST.in

@@ -52,4 +52,5 @@ include premise/data/utils/logging/*.yaml
 include premise/data/utils/validation/*.yaml
 include premise/iam_variables_mapping/*.yaml
 include premise/iam_variables_mapping/*.xlsx
+include premise/iam_variables_mapping/topologies/*.json
 include premise/data/consequential/*.yaml

{premise-1.8.2.dev0/premise.egg-info → premise-1.8.2.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: premise
-Version: 1.8.2.dev0
+Version: 1.8.2.dev2
 Summary: Coupling IAM output to ecoinvent LCA database ecoinvent for prospective LCA
 Author-email: Romain Sacchi <romain.sacchi@psi.ch>, Alois Dirnaichner <dirnaichner@pik-potsdam.de>,  Chris Mutel <cmutel@gmail.com>
 Maintainer-email: Romain Sacchi <romain.sacchi@psi.ch>

{premise-1.8.2.dev0 → premise-1.8.2.dev2}/premise/__init__.py

@@ -1,5 +1,5 @@
 __all__ = ("NewDatabase", "clear_cache", "get_regions_definition")
-__version__ = (1, 8, 2, "dev0")
+__version__ = (1, 8, 2, "dev2")
 
 
 from .ecoinvent_modification import NewDatabase

premise-1.8.2.dev2/premise/biomass.py

@@ -0,0 +1,314 @@
+"""
+biomass.py contains the class `Biomass`, which inherits from `BaseTransformation`.
+This class transforms the biomass markets that feed heât and power plants,
+based on projections from the IAM scenario.
+It eventually re-links all the biomass-consuming activities of the wurst database to
+the newly created biomass markets.
+
+"""
+
+import yaml
+
+from .export import biosphere_flows_dictionary
+from .filesystem_constants import VARIABLES_DIR
+from .logger import create_logger
+from .transformation import (
+    BaseTransformation,
+    IAMDataCollection,
+    InventorySet,
+    List,
+    get_shares_from_production_volume,
+    np,
+    uuid,
+    ws,
+)
+from .utils import eidb_label
+from .validation import BiomassValidation
+
+IAM_BIOMASS_VARS = VARIABLES_DIR / "biomass_variables.yaml"
+
+logger = create_logger("biomass")
+
+
+def _update_biomass(
+    scenario,
+    version,
+    system_model,
+    use_absolute_efficiency,
+    cache=None,
+):
+    biomass = Biomass(
+        database=scenario["database"],
+        iam_data=scenario["iam data"],
+        model=scenario["model"],
+        pathway=scenario["pathway"],
+        year=scenario["year"],
+        version=version,
+        system_model=system_model,
+        use_absolute_efficiency=use_absolute_efficiency,
+        cache=cache,
+    )
+
+    if scenario["iam data"].biomass_markets is not None:
+        biomass.create_biomass_markets()
+
+    biomass.relink_datasets()
+
+    validate = BiomassValidation(
+        model=scenario["model"],
+        scenario=scenario["pathway"],
+        year=scenario["year"],
+        regions=scenario["iam data"].regions,
+        database=biomass.database,
+        iam_data=scenario["iam data"],
+    )
+
+    validate.run_biomass_checks()
+
+    scenario["database"] = biomass.database
+    cache = biomass.cache
+
+    return scenario, cache
+
+
+class Biomass(BaseTransformation):
+    """
+    Class that modifies biomass markets in the database based on IAM output data.
+    Inherits from `transformation.BaseTransformation`.
+
+    :ivar database: wurst database, which is a list of dictionaries
+    :vartype database: list
+    :ivar iam_data: IAM data
+    :vartype iam_data: xarray.DataArray
+    :ivar model: name of the IAM model (e.g., "remind", "image")
+    :vartype model: str
+    :vartype pathway: str
+    :ivar year: year of the pathway (e.g., 2030)
+    :vartype year: int
+
+    """
+
+    def __init__(
+        self,
+        database: List[dict],
+        iam_data: IAMDataCollection,
+        model: str,
+        pathway: str,
+        year: int,
+        version: str,
+        system_model: str,
+        use_absolute_efficiency: bool = False,
+        cache: dict = None,
+    ) -> None:
+        super().__init__(
+            database,
+            iam_data,
+            model,
+            pathway,
+            year,
+            version,
+            system_model,
+            cache,
+        )
+        self.system_model = system_model
+        self.biosphere_dict = biosphere_flows_dictionary(self.version)
+
+    def create_biomass_markets(self) -> None:
+        # print("Create biomass markets.")
+
+        with open(IAM_BIOMASS_VARS, "r", encoding="utf-8") as stream:
+            biomass_map = yaml.safe_load(stream)
+
+        # create region-specific "Supply of forest residue" datasets
+        forest_residues_ds = self.fetch_proxies(
+            name=biomass_map["biomass - residual"]["ecoinvent_aliases"]["fltr"]["name"],
+            ref_prod=biomass_map["biomass - residual"]["ecoinvent_aliases"]["fltr"][
+                "reference product"
+            ][0],
+            production_variable="biomass - residual",
+        )
+
+        # add them to the database
+        self.database.extend(forest_residues_ds.values())
+
+        # add log
+        for dataset in list(forest_residues_ds.values()):
+            self.write_log(dataset=dataset)
+            self.add_to_index(dataset)
+
+        for region in self.regions:
+            dataset = {
+                "name": "market for biomass, used as fuel",
+                "reference product": "biomass, used as fuel",
+                "location": region,
+                "comment": f"Biomass market, created by `premise`, "
+                f"to align with projections for the region {region} in {self.year}. "
+                "Calculated for an average energy input (LHV) of 19 MJ/kg, dry basis. "
+                "Sum of inputs can be superior to 1, as "
+                "inputs of wood chips, wet-basis, have been multiplied by a factor 2.5, "
+                "to reach a LHV of 19 MJ (they have a LHV of 7.6 MJ, wet basis).",
+                "unit": "kilogram",
+                "database": eidb_label(
+                    self.model,
+                    self.scenario,
+                    self.year,
+                    self.version,
+                    self.system_model,
+                ),
+                "code": str(uuid.uuid4().hex),
+                "exchanges": [
+                    {
+                        "name": "market for biomass, used as fuel",
+                        "product": "biomass, used as fuel",
+                        "amount": 1,
+                        "unit": "kilogram",
+                        "location": region,
+                        "uncertainty type": 0,
+                        "type": "production",
+                    }
+                ],
+            }
+
+            available_biomass_vars = [
+                v
+                for v in list(biomass_map.keys())
+                if v in self.iam_data.production_volumes.variables.values
+            ]
+
+            for biomass_type, biomass_act in biomass_map.items():
+                total_prod_vol = np.clip(
+                    (
+                        self.iam_data.production_volumes.sel(
+                            variables=available_biomass_vars, region=region
+                        )
+                        .interp(year=self.year)
+                        .sum(dim="variables")
+                    ),
+                    1e-6,
+                    None,
+                )
+
+                if biomass_type in available_biomass_vars:
+                    share = np.clip(
+                        (
+                            self.iam_data.production_volumes.sel(
+                                variables=biomass_type, region=region
+                            )
+                            .interp(year=self.year)
+                            .sum()
+                            / total_prod_vol
+                        ).values.item(0),
+                        0,
+                        1,
+                    )
+                elif (
+                    self.system_model == "consequential"
+                    and biomass_type == "biomass - residual"
+                ):
+                    share = 0
+                else:
+                    share = 0
+
+                if share > 0:
+                    ecoinvent_regions = self.geo.iam_to_ecoinvent_location(
+                        dataset["location"]
+                    )
+                    possible_locations = [
+                        dataset["location"],
+                        *ecoinvent_regions,
+                        "RER",
+                        "Europe without Switzerland",
+                        "RoW",
+                        "GLO",
+                    ]
+                    possible_name = biomass_act["ecoinvent_aliases"]["fltr"]["name"]
+                    possible_product = biomass_act["ecoinvent_aliases"]["fltr"][
+                        "reference product"
+                    ]
+
+                    suppliers, counter = [], 0
+
+                    while not suppliers:
+                        suppliers = list(
+                            ws.get_many(
+                                self.database,
+                                ws.contains("name", possible_name),
+                                ws.equals("location", possible_locations[counter]),
+                                ws.contains("reference product", possible_product),
+                                ws.equals("unit", "kilogram"),
+                                ws.doesnt_contain_any(
+                                    "name", ["willow", "post-consumer"]
+                                ),
+                            )
+                        )
+                        counter += 1
+
+                    suppliers = get_shares_from_production_volume(suppliers)
+
+                    for supplier, supply_share in suppliers.items():
+                        multiplication_factor = 1.0
+                        amount = supply_share * share * multiplication_factor
+
+                        dataset["exchanges"].append(
+                            {
+                                "type": "technosphere",
+                                "product": supplier[2],
+                                "name": supplier[0],
+                                "unit": supplier[-1],
+                                "location": supplier[1],
+                                "amount": amount,
+                                "uncertainty type": 0,
+                            }
+                        )
+
+                if "log parameters" not in dataset:
+                    dataset["log parameters"] = {}
+
+                dataset["log parameters"].update(
+                    {
+                        "biomass share": share,
+                    }
+                )
+
+            self.database.append(dataset)
+
+            # add log
+            self.write_log(dataset=dataset)
+            self.add_to_index(dataset)
+
+        # replace biomass inputs
+        for dataset in ws.get_many(
+            self.database,
+            ws.either(
+                *[ws.equals("unit", unit) for unit in ["kilowatt hour", "megajoule"]]
+            ),
+            ws.either(
+                *[
+                    ws.contains("name", name)
+                    for name in ["electricity", "heat", "power"]
+                ]
+            ),
+        ):
+            for exc in ws.technosphere(
+                dataset,
+                ws.contains("name", "market for wood chips"),
+                ws.equals("unit", "kilogram"),
+            ):
+                exc["name"] = "market for biomass, used as fuel"
+                exc["product"] = "biomass, used as fuel"
+
+                if dataset["location"] in self.regions:
+                    exc["location"] = dataset["location"]
+                else:
+                    exc["location"] = self.ecoinvent_to_iam_loc[dataset["location"]]
+
+    def write_log(self, dataset, status="created"):
+        """
+        Write log file.
+        """
+
+        logger.info(
+            f"{status}|{self.model}|{self.scenario}|{self.year}|"
+            f"{dataset['name']}|{dataset['location']}|"
+            f"{dataset.get('log parameters', {}).get('biomass share', '')}"
+        )

{premise-1.8.2.dev0 → premise-1.8.2.dev2}/premise/brightway2.py

@@ -18,6 +18,7 @@ class BW2Importer(LCIImporter):
     def write_database(self):
         if self.db_name in databases:
             print(f"Database {self.db_name} already exists: it will be overwritten.")
+            del databases[self.db_name]
         super().write_database()
 
 

{premise-1.8.2.dev0 → premise-1.8.2.dev2}/premise/data/consequential/blacklist.yaml

@@ -227,3 +227,30 @@
     name: market for carbon dioxide, liquid
     reference product: carbon dioxide, liquid
     location: RoW
+
+- name: waste paper, unsorted, Recycled Content cut-off
+  reference product: waste paper, unsorted
+  unit: kilogram
+  location: GLO
+  replacement:
+    name: market for waste paper, unsorted
+    reference product: waste paper, unsorted
+    location: RoW
+
+- name: waste wood, post-consumer, Recycled Content cut-off
+  reference product: waste wood, post-consumer
+  unit: kilogram
+  location: GLO
+  replacement:
+    name: market for waste wood, post-consumer
+    reference product: waste wood, post-consumer
+    location: RoW
+
+- name: iron scrap, unsorted, Recycled Content cut-off
+  reference product: iron scrap, unsorted
+  unit: kilogram
+  location: GLO
+  replacement:
+    name: market for iron scrap, unsorted
+    reference product: iron scrap, unsorted
+    location: GLO

{premise-1.8.2.dev0 → premise-1.8.2.dev2}/premise/data/consequential/leadtimes.yaml

@@ -45,20 +45,20 @@ diesel, synthetic, from wood: 3
 diesel, synthetic, from wood, with CCS: 3
 diesel, synthetic, from grass: 3
 diesel, synthetic, from grass, with CCS: 3
-biodiesel, oil: 3
-biodiesel, oil, with CCS: 3
-bioethanol, wood: 3
-bioethanol, wood, with CCS: 3
-bioethanol, grass: 3
-bioethanol, grass, with CCS: 3
-bioethanol, grain: 3
-bioethanol, grain, with CCS: 3
-bioethanol, sugar: 3
-bioethanol, sugar, with CCS: 3
-methanol, wood: 3
-methanol, wood, with CCS: 3
-methanol, grass: 3
-methanol, grass, with CCS: 3
+biodiesel, from used cooking oil: 3
+biodiesel, from used cooking oil, with CCS: 3
+bioethanol, from wood: 3
+bioethanol, from wood, with CCS: 3
+bioethanol, from grass: 3
+bioethanol, from grass, with CCS: 3
+bioethanol, from grain: 3
+bioethanol, from grain, with CCS: 3
+bioethanol, from sugar: 3
+bioethanol, from sugar, with CCS: 3
+methanol, from wood: 3
+methanol, from wood, with CCS: 3
+methanol, from grass: 3
+methanol, from grass, with CCS: 3
 natural gas: 3
 biomethane: 3
 petrol, synthetic, from electrolysis: 3
@@ -67,14 +67,14 @@ petrol, synthetic, from coal, with CCS: 3
 diesel, synthetic, from electrolysis: 3
 diesel, synthetic, from coal: 3
 diesel, synthetic, from coal, with CCS: 3
-hydrogen, electrolysis: 3
-hydrogen, biomass: 3
-hydrogen, biomass, with CCS: 3
-hydrogen, coal: 3
-hydrogen, nat. gas: 3
-hydrogen, nat. gas, with CCS: 3
-hydrogen, coal, with CCS: 3
-hydrogen, solar: 3
+hydrogen, from electrolysis: 3
+hydrogen, from biomass: 3
+hydrogen, from biomass, with CCS: 3
+hydrogen, from coal: 3
+hydrogen, from natural gas: 3
+hydrogen, from natural gas, with CCS: 3
+hydrogen, from coal, with CCS: 3
+hydrogen, from solar: 3
 cement, dry feed rotary kiln: 10
 steel - primary: 10
 steel - secondary: 10

{premise-1.8.2.dev0 → premise-1.8.2.dev2}/premise/data/consequential/lifetimes.yaml

@@ -43,20 +43,20 @@ diesel, synthetic, from wood: 35
 diesel, synthetic, from wood, with CCS: 35
 diesel, synthetic, from grass: 35
 diesel, synthetic, from grass, with CCS: 35
-biodiesel, oil: 35
-biodiesel, oil, with CCS: 35
-bioethanol, wood: 35
-bioethanol, wood, with CCS: 35
-bioethanol, grass: 35
-bioethanol, grass, with CCS: 35
-bioethanol, grain: 35
-bioethanol, grain, with CCS: 35
-bioethanol, sugar: 35
-bioethanol, sugar, with CCS: 35
-methanol, wood: 35
-methanol, wood, with CCS: 35
-methanol, grass: 35
-methanol, grass, with CCS: 35
+biodiesel, from used cooking oil: 35
+biodiesel, from used cooking oil, with CCS: 35
+bioethanol, from wood: 35
+bioethanol, from wood, with CCS: 35
+bioethanol, from grass: 35
+bioethanol, from grass, with CCS: 35
+bioethanol, from grain: 35
+bioethanol, from grain, with CCS: 35
+bioethanol, from sugar: 35
+bioethanol, from sugar, with CCS: 35
+methanol, from wood: 35
+methanol, from wood, with CCS: 35
+methanol, from grass: 35
+methanol, from grass, with CCS: 35
 natural gas: 35
 biomethane: 35
 petrol, synthetic, from electrolysis: 35
@@ -65,14 +65,14 @@ petrol, synthetic, from coal, with CCS: 35
 diesel, synthetic, from electrolysis: 35
 diesel, synthetic, from coal: 35
 diesel, synthetic, from coal, with CCS: 35
-hydrogen, electrolysis: 35
-hydrogen, biomass: 35
-hydrogen, biomass, with CCS: 35
-hydrogen, coal: 35
-hydrogen, nat. gas: 35
-hydrogen, nat. gas, with CCS: 35
-hydrogen, coal, with CCS: 35
-hydrogen, solar: 35
+hydrogen, from electrolysis: 35
+hydrogen, from biomass: 35
+hydrogen, from biomass, with CCS: 35
+hydrogen, from coal: 35
+hydrogen, from natural gas: 35
+hydrogen, from natural gas, with CCS: 35
+hydrogen, from coal, with CCS: 35
+hydrogen, from solar: 35
 cement, dry feed rotary kiln: 40
 steel - primary: 40
 steel - secondary: 40

premise-1.8.2.dev2/premise/data/fuels/fuel_groups.yaml

@@ -0,0 +1,36 @@
+gasoline:
+  - gasoline
+  - bioethanol, from wood
+  - bioethanol, from wood, with CCS
+  - bioethanol, from grass
+  - bioethanol, from grass, with CCS
+  - bioethanol, from grain
+  - bioethanol, from grain, with CCS
+  - bioethanol, from sugar
+  - bioethanol, from sugar, with CCS
+  - methanol, from wood
+  - methanol, from wood, with CCS
+  - methanol, from grass
+  - methanol, from grass, with CCS
+diesel:
+  - diesel
+  - diesel, synthetic, from wood
+  - diesel, synthetic, from wood, with CCS
+  - diesel, synthetic, from grass
+  - diesel, synthetic, from grass, with CCS
+  - biodiesel, from used cooking oil
+  - biodiesel, from used cooking oil, with CCS
+gas:
+  - natural gas
+  - biomethane
+
+hydrogen:
+  - hydrogen, from electrolysis
+  - hydrogen, from biomass
+  - hydrogen, from biomass, with CCS
+  - hydrogen, from coal
+  - hydrogen, from coal, with CCS
+  - hydrogen, from natural gas
+  - hydrogen, from natural gas, with CCS
+
+

{premise-1.8.2.dev0 → premise-1.8.2.dev2}/premise/data/fuels/hydrogen_activities.yml

@@ -1,66 +1,66 @@
 from electrolysis:
   name: hydrogen production, gaseous, 30 bar, from PEM electrolysis, from grid electricity
-  var: hydrogen, electrolysis
+  var: hydrogen, from electrolysis
   feedstock name: electricity, low voltage
   feedstock unit: kilowatt hour
   floor value: 48.0
 from SMR of biogas, with CCS:
   name: hydrogen production, steam methane reforming, from biomethane, high and low temperature, with CCS (MDEA, 98% eff.), 26 bar
-  var: hydrogen, biomass, with CCS
+  var: hydrogen, from biogas, with CCS
   feedstock name: biomethane
   feedstock unit: kilogram
   floor value: 3.2
 from SMR of biogas:
   name: hydrogen production, steam methane reforming, from biomethane, high and low temperature, 26 bar
-  var: hydrogen, biomass
+  var: hydrogen, from biogas
   feedstock name: biomethane
   feedstock unit: kilogram
   floor value: 3.2
-from SMR of nat. gas:
+from SMR of natural gas:
   name: hydrogen production, steam methane reforming of natural gas, 25 bar
-  var: hydrogen, nat. gas
+  var: hydrogen, from natural gas
   feedstock name: natural gas
   feedstock unit: cubic meter
   floor value: 3.5
-from SMR of nat. gas, with CCS:
+from SMR of natural gas, with CCS:
   name: hydrogen production, steam methane reforming of natural gas, with CCS (MDEA, 98% eff.), 25 bar
-  var: hydrogen, nat. gas, with CCS
+  var: hydrogen, from natural gas, with CCS
   feedstock name: natural gas
   feedstock unit: cubic meter
   floor value: 3.5
 from gasification of biomass, with CCS:
   name: hydrogen production, gaseous, 25 bar, from gasification of woody biomass in entrained flow gasifier, with CCS, at gasification plant
-  var: hydrogen, biomass, with CCS
+  var: hydrogen, from biomass, with CCS
   feedstock name: wood chips
   feedstock unit: kilogram
   floor value: 7
 from gasification of biomass:
   name: hydrogen production, gaseous, 25 bar, from gasification of woody biomass in entrained flow gasifier, at gasification plant
-  var: hydrogen, biomass
+  var: hydrogen, from biomass
   feedstock name: wood chips
   feedstock unit: kilogram
   floor value: 7
 from coal gasification:
   name: hydrogen production, gaseous, 30 bar, from hard coal gasification and reforming, at coal gasification plant
-  var: hydrogen, coal
+  var: hydrogen, from coal
   feedstock name: hard coal
   feedstock unit: kilogram
   floor value: 5
 from coal gasification, with CCS:
   name: hydrogen production, gaseous, 30 bar, from hard coal gasification and reforming, with CCS, at coal gasification plant
-  var: hydrogen, coal
+  var: hydrogen, from coal, with CCS
   feedstock name: hard coal
   feedstock unit: kilogram
   floor value: 5
 from pyrolysis:
   name: hydrogen production, gaseous, 100 bar, from methane pyrolysis
-  var: hydrogen, pyrolsis
+  var: hydrogen, from pyrolysis
   feedstock name: natural gas
   feedstock unit: cubic meter
   floor value: 6.5
 from thermochemical water splitting:
   name: hydrogen production, gaseous, 25 bar, from thermochemical water splitting, at solar tower
-  var: hydrogen, solar
+  var: hydrogen, from solar
   feedstock name: Energy, solar, converted
   feedstock unit: megajoule
   floor value: 180

{premise-1.8.2.dev0 → premise-1.8.2.dev2}/premise/data/utils/export/flows_biosphere_39.csv

@@ -2062,6 +2062,7 @@ Plutonium-alpha;air;urban air close to ground;kilo Becquerel;56bfa732-8223-4091-
 Dichlorprop-P;soil;agricultural;kilogram;02dd7309-b7c2-47bb-82c8-09345be9c2bb
 Caesium-136;water;ground-, long-term;kilo Becquerel;f577fd0b-1d06-40cb-9c9f-682d12b9515f
 Gas, natural;natural resource;in ground;standard cubic meter;7c337428-fb1b-45c7-bbb2-2ee4d29e17ba
+Gas, natural;natural resource;in ground;Sm3;7c337428-fb1b-45c7-bbb2-2ee4d29e17ba
 Hydrocarbons, aliphatic, alkanes, cyclic;air;low population density, long-term;kilogram;a97ba30e-898d-4e73-bd62-ec8f636659c2
 Xylene;air;lower stratosphere + upper troposphere;kilogram;6da40876-a6ab-459e-ba17-9a5e3d4da146
 Metconazole;water;surface water;kilogram;3c1c8501-4d95-58ee-935e-44bc99853bf4

{premise-1.8.2.dev0 → premise-1.8.2.dev2}/premise/data/utils/logging/logconfig.yaml

@@ -16,6 +16,14 @@ handlers:
     formatter: simple
     mode: w
 
+  file_biomass:
+    class: logging.FileHandler
+    level: INFO
+    filename: "export/logs/premise_biomass.log"
+    encoding: utf8
+    formatter: simple
+    mode: w
+
   file_electricity:
     class: logging.FileHandler
     level: INFO
@@ -94,6 +102,11 @@ loggers:
     handlers: [file_dac]
     propagate: False
 
+  biomass:
+    level: INFO
+    handlers: [ file_biomass ]
+    propagate: False
+
   electricity:
     level: INFO
     handlers: [ file_electricity ]