openepd 0.5.0__tar.gz → 0.7.0__tar.gz

{openepd-0.5.0 → openepd-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openepd
-Version: 0.5.0
+Version: 0.7.0
 Summary: Python library to work with OpenEPD format
 Home-page: https://github.com/cchangelabs/openepd
 License: Apache-2.0

{openepd-0.5.0 → openepd-0.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openepd"
-version = "0.5.0"
+version = "0.7.0"
 license = "Apache-2.0"
 description = "Python library to work with OpenEPD format"
 authors = ["C-Change Labs <support@c-change-labs.com>"]
@@ -56,7 +56,7 @@ types-deprecated = ">=1.2.9"
 
 
 [tool.commitizen]
-version = "0.5.0"
+version = "0.7.0"
 bump_version = "bump: version $current_version → $new_version"
 update_changelog_on_bump = true
 pre_bump_hooks = []

{openepd-0.5.0 → openepd-0.7.0}/src/openepd/__version__.py

@@ -17,4 +17,4 @@
 #  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
 #  Find out more at www.BuildingTransparency.org
 #
-VERSION = "0.5.0"
+VERSION = "0.7.0"

{openepd-0.5.0 → openepd-0.7.0}/src/openepd/model/common.py

@@ -17,9 +17,10 @@
 #  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
 #  Find out more at www.BuildingTransparency.org
 #
-from typing import Annotated
+from typing import Annotated, Any
 
 import pydantic as pyd
+from pydantic import root_validator
 
 from openepd.model.base import BaseOpenEpdSchema
 
@@ -27,8 +28,19 @@ from openepd.model.base import BaseOpenEpdSchema
 class Amount(BaseOpenEpdSchema):
     """A value-and-unit pairing for amounts that do not have an uncertainty."""
 
-    qty: float | None = pyd.Field(description="How much of this in the amount.")
-    unit: str = pyd.Field(description="Which unit.  SI units are preferred.", example="kg")
+    qty: float | None = pyd.Field(description="How much of this in the amount.", default=None)
+    unit: str | None = pyd.Field(description="Which unit.  SI units are preferred.", example="kg", default=None)
+
+    @root_validator
+    def check_qty_or_unit(cls, values: dict[str, Any]):
+        """Ensure that qty or unit is provided."""
+        if values["qty"] is None and values["unit"] is None:
+            raise ValueError("Either qty or unit must be provided.")
+        return values
+
+    def to_quantity_str(self):
+        """Return a string representation of the amount."""
+        return f"{self.qty or ''} {self.unit or 'str'}".strip()
 
 
 class Measurement(BaseOpenEpdSchema):
@@ -42,10 +54,29 @@ class Measurement(BaseOpenEpdSchema):
     dist: str | None = pyd.Field(description="Statistical distribution of the measurement error.", default=None)
 
 
+class Ingredient(BaseOpenEpdSchema):
+    """
+    An ingredient of a product.
+
+    The Ingredients list gives the core data references and quantities. This list is used to document supply-chain
+    transparency, such as the EPDs of major components (e.g. cement in concrete, or recycled steel
+    in hot-rolled sections).
+    """
+
+    qty: float | None = pyd.Field(
+        description="Number of declared units of this consumed. Negative values indicate an outflow."
+    )
+    link: pyd.AnyUrl | None = pyd.Field(
+        description="Link to this object's OpenEPD declaration. "
+        "An OpenIndustryEPD or OpenLCI link is also acceptable.",
+        default=None,
+    )
+
+
 class WithAttachmentsMixin:
     """Mixin for objects that can have attachments."""
 
-    attachments: dict[Annotated[str, pyd.constr(max_length=200)], pyd.AnyUrl] | None = pyd.Field(
+    attachments: dict[Annotated[str, pyd.Field(max_length=200)], pyd.AnyUrl] | None = pyd.Field(
         description="Dict of URLs relevant to this entry",
         example={
             "Contact Us": "https://www.c-change-labs.com/en/contact-us/",

{openepd-0.5.0 → openepd-0.7.0}/src/openepd/model/epd.py

@@ -18,14 +18,15 @@
 #  Find out more at www.BuildingTransparency.org
 #
 import datetime
-from typing import Literal
+from typing import Annotated, Literal
 
 import pydantic as pyd
 
 from openepd.model.base import BaseOpenEpdSchema
-from openepd.model.common import Amount
+from openepd.model.common import Amount, Ingredient
 from openepd.model.lcia import ImpactSet, OutputFlowSet, ResourceUseSet
 from openepd.model.org import Org, Plant
+from openepd.model.pcr import Pcr
 from openepd.model.specs import Specs
 from openepd.model.standard import Standard
 
@@ -46,7 +47,23 @@ class Epd(BaseOpenEpdSchema):
     product_name: str = pyd.Field(
         max_length=200, description="The name of the product described by this EPD", example="Mix 12345AC"
     )
+    product_sku: str | None = pyd.Field(
+        max_length=200, description="Unique stock keeping identifier assigned by manufacturer"
+    )
+    product_description: str | None = pyd.Field(
+        max_length=2000,
+        description="1-paragraph description of product. " "Supports plain text or github flavored markdown.",
+    )
     # TODO: add product_alt_names? E.g. ILCD has a list of synonymous names
+    product_classes: dict[str, str] = pyd.Field(
+        description="List of classifications, including Masterformat and UNSPC", default_factory=dict
+    )
+    product_image_small: pyd.AnyUrl | None = pyd.Field(
+        description="Pointer to image illustrating the product, which is no more than 200x200 pixels", default=None
+    )
+    product_image: pyd.AnyUrl | None = pyd.Field(
+        description="pointer to image illustrating the product no more than 10MB", default=None
+    )
     version: pyd.PositiveInt = pyd.Field(
         description="Version of this document. The document's issuer should increment it anytime even a single "
         "character changes, as this value is used to determine the most recent version.",
@@ -104,14 +121,76 @@ class Epd(BaseOpenEpdSchema):
         example=datetime.date(day=11, month=9, year=2028),
         description="Last date the EPD is valid on, including any extensions.",
     )
-    product_class: dict[str, str] = pyd.Field(
-        description="List of classifications, including Masterformat and UNSPC", default_factory=dict
+    pcr: Pcr | None = pyd.Field(
+        description="JSON object for product category rules. Should point to the "
+        "most-specific PCR that applies; the PCR entry should point to any "
+        "parent PCR.",
+        default=None,
     )
     declared_unit: Amount | None = pyd.Field(
         description="SI declared unit for this EPD.  If a functional unit is "
         "utilized, the declared unit shall refer to the amount of "
         "product associated with the A1-A3 life cycle stage."
     )
+    kg_per_declared_unit: Amount | None = pyd.Field(
+        default=None,
+        description="Mass of the product, in kilograms, per declared unit",
+        example=Amount(qty=12.5, unit="kg"),
+    )
+    kg_C_per_declared_unit: Amount | None = pyd.Field(
+        default=None,
+        description="Mass of elemental carbon, per declared unit, contained in the product itself at the manufacturing "
+        "facility gate.  Used (among other things) to check a carbon balance or calculate incineration "
+        "emissions.  The source of carbon (e.g. biogenic) is not relevant in this field.",
+        example=Amount(qty=8.76, unit="kg"),
+    )
+    kg_C_biogenic_per_declared_unit: Amount | None = pyd.Field(
+        default=None,
+        description="Mass of elemental carbon from biogenic sources, per declared unit, contained in the product "
+        "itself at the manufacturing facility gate.  It may be presumed that any biogenic carbon content "
+        "has been accounted for as -44/12 kgCO2e per kg C in stages A1-A3, per EN15804 and ISO 21930.",
+        example=Amount(qty=8.76, unit="kg"),
+    )
+    product_service_life_years: float | None = pyd.Field(
+        gt=0.0009,
+        lt=101,
+        description="Reference service life of the product, in years.  Serves as a maximum for replacement interval, "
+        "which may also be constrained by usage or the service life of what the product goes into "
+        "(e.g. a building).",
+        example=50.0,
+    )
+    annual_production: float | None = pyd.Field(
+        gt=0,
+        default=None,
+        description="Approximate annual production volume, in declared units, of product covered by this EPD. "
+        "This value is intended to be used for weighting of averages. "
+        "Providing this data is optional, and it is acceptable to round or obfuscate it downwards "
+        "(but not upwards) by any amount desired to protect confidentiality. For example, if the "
+        "product volume is 123,456 m3, a value of 120,000, 100,000 or even 87,654 would be acceptable.",
+        example=10000,
+    )
+    applicable_in: list[Annotated[str, pyd.Field(min_length=2, max_length=2)]] | None = pyd.Field(
+        max_items=100,
+        default=None,
+        description="Jurisdiction(s) in which EPD is applicable. An empty array, or absent properties, "
+        "implies global applicability.",
+        example=["US", "CA", "MX"],
+    )
+    product_usage_description: str | None = pyd.Field(
+        default=None,
+        description="Text description of how product is typically used. Can be used to describe accessories "
+        "like fasteners, adhesives, etc.  Supports plain text or github flavored markdown.",
+    )
+    product_usage_image: pyd.AnyUrl | None = pyd.Field(
+        description="Pointer (url) to image illustrating how the product is used. No more than 10MB.", default=None
+    )
+    manufacturing_description: str | None = pyd.Field(
+        default=None,
+        description="Text description of manufacturing process.  Supports plain text or github flavored markdown.",
+    )
+    manufacturing_image: pyd.AnyUrl | None = pyd.Field(
+        description="Pointer (url) to an image illustrating the manufacturing process. No more than 10MB.", default=None
+    )
     impacts: ImpactSet | None = pyd.Field(
         description="List of environmental impacts, compiled per one of the standard Impact Assessment methods"
     )
@@ -129,6 +208,11 @@ class Epd(BaseOpenEpdSchema):
         default_factory=Specs,
         description="Data structure(s) describing performance specs of product. Unique for each material type.",
     )
+    includes: list[Ingredient] = pyd.Field(
+        max_items=255,
+        description="List of JSON objects pointing to product components. "
+        "Each one should be an EPD or digitized LCI process.",
+    )
     lca_discussion: str | None = pyd.Field(
         max_length=20000,
         description="""A rich text description containing information for experts reviewing the EPD contents. 

{openepd-0.5.0 → openepd-0.7.0}/src/openepd/model/lcia.py

@@ -161,9 +161,41 @@ class ResourceUseSet(BaseOpenEpdSchema):
         description="Renewable primary resources with energy content used as material. "
         "First use biobased materials used as materials (e.g. wood, hemp, etc.)."
     )
+    rpre: ScopeSet | None = pyd.Field(description="Renewable primary energy resources as energy")
+    nrpre: ScopeSet | None = pyd.Field(description="Non-renewable primary resources as energy (fuel)")
+    nrprm: ScopeSet | None = pyd.Field(description="Non-renewable primary resources as material")
+    fw: ScopeSet | None = pyd.Field(description="Use of net fresh water")
+    sm: ScopeSet | None = pyd.Field(description="Use of secondary materials")
+    rsf: ScopeSet | None = pyd.Field(description="Use of renewable secondary materials")
+    nrsf: ScopeSet | None = pyd.Field(description="Use of non-renewable secondary fuels")
+    re: ScopeSet | None = pyd.Field(description="Renewable energy resources")
+    pere: ScopeSet | None = pyd.Field(
+        description="Use of renewable primary energy excluding renewable primary energy resources used as raw materials"
+    )
+    perm: ScopeSet | None = pyd.Field(description="Use of renewable primary energy resources used as raw materials")
+    pert: ScopeSet | None = pyd.Field(description="Total use of renewable primary energy resources")
+    penre: ScopeSet | None = pyd.Field(
+        description="Use of non-renewable primary energy excluding "
+        "non-renewable primary energy resources used as raw materials"
+    )
+    penrm: ScopeSet | None = pyd.Field(
+        description="Use of non-renewable primary energy resources used as raw materials"
+    )
+    penrt: ScopeSet | None = pyd.Field(description="Total use of non-renewable primary energy resources")
 
 
 class OutputFlowSet(BaseOpenEpdSchema):
     """A set of output flows, such as waste, emissions, etc."""
 
+    twd: ScopeSet | None = pyd.Field(description="Total waste disposed")
     hwd: ScopeSet | None = pyd.Field(description="Hazardous waste disposed")
+    nhwd: ScopeSet | None = pyd.Field(description="Non-hazardous waste disposed")
+    rwd: ScopeSet | None = pyd.Field(description="Radioactive waste disposed")
+    hlrw: ScopeSet | None = pyd.Field(description="High level radioactive waste disposed")
+    illrw: ScopeSet | None = pyd.Field(description="Intermediate level radioactive waste disposed")
+    cru: ScopeSet | None = pyd.Field(description="Components for re-use")
+    mr: ScopeSet | None = pyd.Field(description="Recycled materials")
+    mfr: ScopeSet | None = pyd.Field(description="Materials for recycling")
+    mer: ScopeSet | None = pyd.Field(description="Materials for energy recovery")
+    ee: ScopeSet | None = pyd.Field(description="Exported energy")
+    eh: ScopeSet | None = pyd.Field(description="Exported heat")