openepd 6.2.0__py3-none-any.whl → 6.3.1__py3-none-any.whl

openepd/__version__.py

@@ -13,4 +13,4 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-VERSION = "6.2.0"
+VERSION = "6.3.1"

openepd/model/declaration.py

@@ -15,6 +15,7 @@
 #
 import abc
 import datetime
+from enum import StrEnum
 
 from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseOpenEpdSchema, OpenXpdUUID, RootDocument
@@ -50,7 +51,7 @@ class BaseDeclaration(RootDocument, abc.ABC):
         description="Last date the document is valid on, including any extensions.",
     )
 
-    version: pyd.PositiveInt | None = pyd.Field(
+    version: pyd.NonNegativeInt | None = 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.",
         example=1,
@@ -83,7 +84,7 @@ class BaseDeclaration(RootDocument, abc.ABC):
         description="Language this document is captured in, as an ISO 639-1 code",
         example="en",
     )
-    private: bool = pyd.Field(
+    private: bool | None = pyd.Field(
         default=False,
         description="This document's author does not wish the contents published. "
         "Useful for draft, partial, or confidential declarations.  "
@@ -137,7 +138,7 @@ class BaseDeclaration(RootDocument, abc.ABC):
         description="Link to data object on original registrar's site",
         example="https://epd-online.com/EmbeddedEpdList/Download/6029",
     )
-    kg_C_per_declared_unit: AmountGWP | None = pyd.Field(
+    kg_C_per_declared_unit: AmountMass | 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 "
@@ -236,3 +237,75 @@ class RefBase(BaseOpenEpdSchema, title="Ref Object"):
         example="https://openepd.buildingtransparency.org/api/generic_estimates/EC300001",
         description="Reference to this JSON object",
     )
+
+
+class OriginalDataFormat(StrEnum):
+    """
+    Original data format for this EPD.
+
+    A system receiving an EPD via openEPD should preserve this field if it exists.  Otherwise, it is up to the
+    receiving system to infer the original data format based on the source.
+    """
+
+    OPENEPD_1_0 = "openEPDv1.0"
+    """
+    Data was generated in an openEPD-compliant system, such as by manual entry in EC3 or generation in an openEPD
+    compliant EPD generator.
+    """
+
+    CUSTOM_API = "custom_api"
+    """
+    Data was gathered from a non-standardized API offered by a data provider.  Numerical and text data is very likely
+    to be correct and up to date, but important fields may be absent and identification of organizations, plants, and
+     addresses may be ambiguous.
+    """
+
+    ILCD_EPD_v1_2 = "ILCD+EPDv1_2"
+    """
+    Data was generated and published in ILCD+EPD format, version 1.2  Numerical and text data is very likely to be
+    correct and up to date, but important fields may be absent and identification of organizations, plants, and
+    addresses may be ambiguous.
+    """
+
+    ILCD_EPD_v1_1 = "ILCD+EPDv1_1"
+    """
+    Data was generated and published in ILCD+EPD format, version 1.1  Numerical and text data is very likely to be
+    correct and up to date, but important fields may be absent and identification of organizations, plants, and
+    addresses may be ambiguous.
+    """
+
+    ILCD_EPD_v1_0 = "ILCD+EPDv1_0"
+    """
+    Data was generated and published in ILCD+EPD format, version 1.0  Numerical and text data is very likely to be
+    correct and up to date, but important fields may be absent and identification of organizations, plants, and
+    addresses may be ambiguous.
+    """
+
+    WEB = "web"
+    """
+    Data was gathered through comprehension of a viewable HTML page, typically offered by a program operator.
+    This is more reliable than PDF, but less reliable than API or a standardized XML like ILCD+EPD.
+    """
+
+    PDF_MANUAL = "pdf_manual"
+    """
+    Data was entered by hand based on PDF and/or validated by a qualified professional.
+    """
+
+    PDF_MIXED = "pdf_mixed"
+    """
+    Data is a mix of structured data from an information system, but with significant missing data filled in by
+    extraction from a PDF.
+    """
+
+    PDF = "pdf"
+    """
+    Data was extracted by analyzing or comprehending a PDF document.  Includes documents where up to 4 fields (e.g.
+    program operator) were inferred from sources outside the PDF.  This method is prone to errors and omissions due
+    to the many different formats and terms used in these relatively unstructured documents.
+    """
+
+    OTHER = "other"
+    """
+    Data source is not of a type listed here.
+    """

openepd/model/epd.py

@@ -13,20 +13,22 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-from typing import Annotated
 
 from openepd.compat.pydantic import pyd
-from openepd.model.base import BaseDocumentFactory, OpenEpdDoctypes
+from openepd.model.base import BaseDocumentFactory, BaseOpenEpdSchema, OpenEpdDoctypes
 from openepd.model.common import Ingredient, WithAltIdsMixin, WithAttachmentsMixin
 from openepd.model.declaration import (
     DEVELOPER_DESCRIPTION,
     PROGRAM_OPERATOR_DESCRIPTION,
     THIRD_PARTY_VERIFIER_DESCRIPTION,
     BaseDeclaration,
+    OriginalDataFormat,
+    RefBase,
     WithEpdDeveloperMixin,
     WithProgramOperatorMixin,
     WithVerifierMixin,
 )
+from openepd.model.geography import Geography
 from openepd.model.lcia import WithLciaMixin
 from openepd.model.org import Org, Plant
 from openepd.model.specs.singular import Specs
@@ -37,6 +39,94 @@ MANUFACTURER_DESCRIPTION = (
 )
 
 
+#
+#  Copyright 2024 by C Change Labs Inc. www.c-change-labs.com
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+#  This software was developed with support from the Skanska USA,
+#  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
+#  Find out more at www.BuildingTransparency.org
+#
+
+
+class Ec3EpdExtension(BaseOpenEpdSchema):
+    """Extension for EC3 specific fields on openEPD."""
+
+    # While the extensions should be stored under the 'ext' key - extension point of the BaseOpenepdModel - the EC3
+    # extension was started before the introduction of extension management, and so is located at the root of the EPD
+    # object.
+
+    uaGWP_a1a2a3_traci21: float | None = pyd.Field(
+        default=None,
+        description="""The A1A2A3 uncertainty-adjusted GWP, in kgCO2e per declared unit, calculated for the TRACI 2.1
+        LCIA method. This is the value that should be used to compare EPDs against each other, or against an
+        uncertainty-adjusted limit/benchmark, once both have been converted to the same declared unit. This is a
+        materialized value provided for the convenience of integrators, and can be regenerated at any time from the
+         specificity and EC3 category. The value is provided per comparison_unit.""",
+        example=22.5,
+    )
+    uaGWP_a1a2a3_ar5: float | None = pyd.Field(
+        default=None,
+        description="""The A1A2A3 uncertainty-adjusted GWP, calculated for the IPCC AR5 LCIA method. This is the value
+        that should be used to compare EPDs against each other, or against an uncertainty-adjusted limit/benchmark,
+        once both have been converted to the same declared unit. This is a materialized value, and can be regenerated
+        at any time from the specificity and EC3 category.""",
+        example=22.5,
+    )
+    category: str | None = pyd.Field(
+        default=None,
+        description="The category of the EPD in EC3 notation. Same as EC3 category from root EPD's product_classes for "
+        "EC3.",
+    )
+    manufacturer_specific: bool | None = pyd.Field(
+        default=None,
+        description="""An EPD is Manufacturer Specific if it is based on data from a single manufacturer, as opposed
+        to an industry group, sector, or generic process. This field should always be true for openEPD documents
+        (as opposed to openIndustryEPDs).""",
+    )
+    plant_specific: bool | None = pyd.Field(
+        default=None,
+        description="""An EPD is Product Specific if it is based on data regarding the specific product being
+        delivered, as opposed to a range of products whose GWP per unit may vary by more than 10%.""",
+    )
+    product_specific: bool | None = pyd.Field(
+        default=None,
+        description="""An EPD is Product Specific if it is based on data regarding the specific product being
+        delivered, as opposed to a range of products whose GWP per unit may vary by more than 10%.""",
+    )
+    batch_specific: bool | None = pyd.Field(
+        default=None,
+        description="""An EPD is Product Specific if it is created with production data for a single production run of
+         no more than 90 days. Typically these must be generated on a just-in-time or on-demand basis.""",
+    )
+    supply_chain_specificity: float | None = pyd.Field(
+        default=None,
+        description="""An EPD is Supply Chain Specific to the extent that impacts of process inputs are based on
+        product-specific, facility-specific EPDs or third-party verified LCA for those inputs. For example, a concrete
+        where the cement impacts are based on a plant-specific, product-specific EPD for the actual cement used would
+         have around 85% supply chain specificity.""",
+    )
+
+    original_data_format: OriginalDataFormat | None = pyd.Field(default=None)
+
+
+class EpdRef(RefBase, title="EPD (Ref)"):
+    """Reference (short) version of EPD object."""
+
+    pass
+
+
 class EpdPreviewV0(
     WithAttachmentsMixin,
     WithProgramOperatorMixin,
@@ -85,7 +175,7 @@ class EpdPreviewV0(
         "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(
+    applicable_in: list[Geography] | None = pyd.Field(
         max_items=100,
         default=None,
         description="Jurisdiction(s) in which EPD is applicable. An empty array, or absent properties, "
@@ -122,6 +212,7 @@ class EpdPreviewV0(
         "Each one should be an EPD or digitized LCI process.",
         default_factory=list,
     )
+    ec3: Ec3EpdExtension | None = pyd.Field(default=None, description="EC3-specific EPD extension.")
 
     @pyd.validator("doctype")
     def validate_doctype(cls, v: str | None) -> str:

openepd/model/lcia.py

@@ -104,7 +104,7 @@ class ScopeSet(BaseOpenEpdSchema):
     )
     B1_years: float | None = pyd.Field(
         gt=0,
-        lt=11,
+        lt=100,
         description="Timeframe over which B1 is evaluated, in years. "
         "For example, an impact of 1.23 kgCO2e per year for ten years could be B1=1.23kgCO2e, "
         "B1_years=1.0 or  B1=12.3kgCO2e, B1_years=10.0",
@@ -116,7 +116,7 @@ class ScopeSet(BaseOpenEpdSchema):
     )
     B2_years: float | None = pyd.Field(
         gt=0,
-        lt=11,
+        lt=100,
         description="Predicted Maintenance Impacts over Reference Service Life",
         default=None,
     )
@@ -126,7 +126,7 @@ class ScopeSet(BaseOpenEpdSchema):
     )
     B3_years: float | None = pyd.Field(
         gt=0,
-        lt=11,
+        lt=100,
         description="Timeframe over which B3 is evaluated, in years",
         default=None,
     )
@@ -137,7 +137,7 @@ class ScopeSet(BaseOpenEpdSchema):
     )
     B4_years: float | None = pyd.Field(
         gt=0,
-        lt=11,
+        lt=100,
         description="Timeframe over which B4 is evaluated, in years",
         default=None,
     )
@@ -148,7 +148,7 @@ class ScopeSet(BaseOpenEpdSchema):
     )
     B5_years: float | None = pyd.Field(
         gt=0,
-        lt=11,
+        lt=100,
         description="Timeframe over which B5 is evaluated, in years",
         default=None,
     )
@@ -158,7 +158,7 @@ class ScopeSet(BaseOpenEpdSchema):
     )
     B6_years: float | None = pyd.Field(
         gt=0,
-        lt=11,
+        lt=100,
         description="Timeframe over which B6 is evaluated, in years",
         default=None,
     )
@@ -168,7 +168,7 @@ class ScopeSet(BaseOpenEpdSchema):
     )
     B7_years: float | None = pyd.Field(
         gt=0,
-        lt=11,
+        lt=100,
         description="Timeframe over which B7 is evaluated, in years",
         default=None,
     )

openepd/model/org.py

@@ -15,6 +15,8 @@
 #
 from typing import Annotated, Optional
 
+from openlocationcode import openlocationcode
+
 from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseOpenEpdSchema
 from openepd.model.common import Location, WithAltIdsMixin, WithAttachmentsMixin
@@ -71,6 +73,12 @@ class Plant(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
         example="865P2W3V+3W.interface.com",
         default=None,
     )
+    pluscode: str | None = pyd.Field(
+        default=None,
+        description="(deprecated) Plus code (aka Open Location Code) of plant's location",
+        deprecated="Pluscode field is deprecated. If users need a pluscode they can obtain it from "
+        "`id` like this: `id.spit('.', maxsplit=1)[0]`",
+    )
     owner: Org | None = pyd.Field(description="Organization that owns the plant", default=None)
     name: str | None = pyd.Field(
         max_length=200,
@@ -93,5 +101,19 @@ class Plant(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
         """Return the asset type of this class (see BaseOpenEpdSchema.get_asset_type for details)."""
         return "org"
 
+    @pyd.validator("id")
+    def _validate_id(cls, v: str) -> str:
+        try:
+            pluscode, web_domain = v.split(".", maxsplit=1)
+        except ValueError as e:
+            raise ValueError("Incorrectly formed id: should be pluscode.owner_web_domain") from e
+
+        if not openlocationcode.isValid(pluscode):
+            raise ValueError("Incorrect pluscode for plant")
+
+        if not web_domain:
+            raise ValueError("Incorrect web_domain for plant")
+        return v
+
     class Config(BaseOpenEpdSchema.Config):
         allow_population_by_field_name = True

{openepd-6.2.0.dist-info → openepd-6.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openepd
-Version: 6.2.0
+Version: 6.3.1
 Summary: Python library to work with OpenEPD format
 Home-page: https://github.com/cchangelabs/openepd
 License: Apache-2.0
@@ -20,6 +20,7 @@ Provides-Extra: api-client
 Requires-Dist: email-validator (>=1.3.1)
 Requires-Dist: idna (>=3.7)
 Requires-Dist: open-xpd-uuid (>=0.2.1,<0.3.0)
+Requires-Dist: openlocationcode (>=1.0.1)
 Requires-Dist: pydantic (>=1.10,<3.0)
 Requires-Dist: requests (>=2.0) ; extra == "api-client"
 Project-URL: Repository, https://github.com/cchangelabs/openepd

{openepd-6.2.0.dist-info → openepd-6.3.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
 openepd/__init__.py,sha256=Shkfh0Kun0YRhmRDw7LkUj2eQL3X-HnP55u2THOEALw,794
-openepd/__version__.py,sha256=jAQO98uPb9JBudq_etYXIE_CAsYMQVe2UwsQNueY3Pw,638
+openepd/__version__.py,sha256=9-O6i7qcYZLc-Ty16U1UcqrtWq9-iQfVCVLwVjya99s,638
 openepd/api/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/api/average_dataset/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/api/average_dataset/generic_estimate_sync_api.py,sha256=mxWwDokEGMe87Px8C_aHvIdVKZVHrEAuVtaSA1zJchU,7953
@@ -36,14 +36,14 @@ openepd/model/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/model/base.py,sha256=OEYNFUTL4BivBNAt_LGowTlDuUjvKMHgf5U5ZBncZwQ,9805
 openepd/model/category.py,sha256=IQXNGQFQmFZ_H9PRONloX_UOSf1sTMDq1rM1yz8JR0Y,1639
 openepd/model/common.py,sha256=yx3m9Tqb7WgqW3SaHB3WftQaShD80dxTys2r63rswy8,9700
-openepd/model/declaration.py,sha256=Wh5Ni6AG903lmPTV5sS627lNjSazH7km3OIr2lkKKJE,11072
-openepd/model/epd.py,sha256=tKT3gCPZXasVd_mCCXLVabZMbuhM9scBEgn7caS_WJM,7488
+openepd/model/declaration.py,sha256=oBJ_v_ESoQhybQIH5S5tmYVkgkoX3gwe3nvFyPqb4uk,13832
+openepd/model/epd.py,sha256=AAksfqbpxBiipwsphPil5MvQouCBDMVcAzvIYkeq5OQ,12070
 openepd/model/factory.py,sha256=XP7eeQNW5tqwX_4hfuEb3lK6BFQDb4KB0fSN0r8-lCU,2656
 openepd/model/generic_estimate.py,sha256=bbU0cR4izSqjZcfxUHNbdO4pllqqd8OaUFikrEgCFoA,3992
 openepd/model/geography.py,sha256=G3Oz3QBw5n-RiSCAv-vAGxrOZBhwIT5rASnPlo9dkcs,42095
 openepd/model/industry_epd.py,sha256=rgXhCUDAgzZ9eGio7ExqE3ymP3zTXnrrwcIDvg5YP1A,3285
-openepd/model/lcia.py,sha256=6aJPmza5BN2YKzSl5IRGVK7lPlBdBFqOJU3977583LY,24383
-openepd/model/org.py,sha256=6nIL6XPHnLdw65YynXtQmZUGfJo2UC9jd1j6iPS0pe8,3734
+openepd/model/lcia.py,sha256=EChQO_zcc9ZV0cYHCsjjO24pn5oi8d3WMeUxB1Cj3Ww,24390
+openepd/model/org.py,sha256=xEYeqcqtmyd9fr322iCYwjhUlpRLREfzDe7gdBL7f04,4588
 openepd/model/pcr.py,sha256=QknLtTn6Y14JORWKQ1qBqGgKnZpbKgqNiYF3Axl4U4c,5494
 openepd/model/specs/README.md,sha256=UGhSiFJ9hOxT1mZl-5ZrhkOrPKf1W_gcu5CI9hzV7LU,2430
 openepd/model/specs/__init__.py,sha256=IAevXqqYrCWlTH4z4Fy9o77vaOLinX56G05iIJJfm0M,3094
@@ -133,7 +133,7 @@ openepd/model/validation/quantity.py,sha256=UP6x2nUj1nP7G8e2rpi-HigHx9rwKeCuIDh_
 openepd/model/versioning.py,sha256=R_zm6rCrgF3vlJQYbpyWhirdS_Oek16cv_mvZmpuE8I,4473
 openepd/patch_pydantic.py,sha256=xrkzblatmU9HBzukWkp1cPq9ZSuohoz1p0pQqVKSlKs,4122
 openepd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openepd-6.2.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-6.2.0.dist-info/METADATA,sha256=f6kiHW5bMVEqEfQFVfPhLlKJDSKQcRMmkuIqZ1GiaKY,8996
-openepd-6.2.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-openepd-6.2.0.dist-info/RECORD,,
+openepd-6.3.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openepd-6.3.1.dist-info/METADATA,sha256=e71TcIfypVycIAtmh7z2JSBoGJSbaP5-RCK_-xEFn2c,9038
+openepd-6.3.1.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+openepd-6.3.1.dist-info/RECORD,,