openepd 2.0.0__py3-none-any.whl → 3.0.0__py3-none-any.whl

openepd/model/pcr.py

@@ -1,5 +1,5 @@
 #
-#  Copyright 2023 by C Change Labs Inc. www.c-change-labs.com
+#  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.
@@ -18,65 +18,93 @@
 #  Find out more at www.BuildingTransparency.org
 #
 import datetime
-from typing import Optional
-
-import pydantic as pyd
+from enum import StrEnum
+from typing import Annotated, Optional
 
+from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseOpenEpdSchema
 from openepd.model.common import WithAltIdsMixin, WithAttachmentsMixin
 from openepd.model.org import Org
 
 
+class PcrStatus(StrEnum):
+    """Status of a PCR."""
+
+    InDevelopment = "InDevelopment"
+    Published = "Published"
+    NonPublic = "NonPublic"
+    Expired = "Expired"
+    Sunset = "Sunset"
+
+
 class Pcr(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
     """Represent a PCR (Product Category Rules)."""
 
     id: str | None = pyd.Field(
         description="The unique ID for this PCR.  To ensure global uniqueness, should be registered "
         "at open-xpd-uuid.cqd.io/register or a coordinating registry.",
+        example="ec3xpgq2",
         default=None,
-        json_schema_extra={"example": "ec3xpgq2"},
     )
     issuer: Org | None = pyd.Field(description="Organization issuing this PCR", default=None)
     issuer_doc_id: str | None = pyd.Field(
         max_length=40,
         default=None,
         description="Document ID or code created by issuer",
-        json_schema_extra=dict(example="c-PCR-003"),
+        example="c-PCR-003",
     )
     name: str | None = pyd.Field(
         max_length=200,
         default=None,
         description="Full document name as listed in source document",
-        json_schema_extra=dict(example="c-PCR-003 Concrete and concrete elements (EN 16757)"),
+        example="c-PCR-003 Concrete and concrete elements (EN 16757)",
     )
     short_name: str | None = pyd.Field(
-        max_length=40,
         default=None,
         description="A shortened name without boilerplate text.",
-        json_schema_extra=dict(example="Concrete and Concrete Elements"),
+        example="Concrete and Concrete Elements",
     )
     version: str | None = pyd.Field(
         description="Document version, as expressed in document.",
+        example="1.0.2",
         default=None,
-        json_schema_extra=dict(example="1.0.2"),
     )
-    date_of_issue: datetime.date | None = pyd.Field(
+    date_of_issue: datetime.datetime | None = pyd.Field(
+        example=datetime.date(day=11, month=2, year=2022),
         default=None,
         description="First day on which the document is valid",
-        json_schema_extra=dict(example=datetime.date(day=11, month=2, year=2022)),
     )
-    valid_until: datetime.date | None = pyd.Field(
+    valid_until: datetime.datetime | None = pyd.Field(
+        example=datetime.date(day=11, month=2, year=2024),
         default=None,
         description="Last day on which the document is valid",
-        json_schema_extra=dict(example=datetime.date(day=11, month=2, year=2024)),
     )
+    doc: str | None = pyd.Field(default=None, description="URL to original document, preferably directly to a PDF.")
     parent: Optional["Pcr"] = pyd.Field(
         description="The parent PCR, base PCR, `Part A` PCR",
         default=None,
     )
+    status: PcrStatus | None = pyd.Field(
+        default=None,
+        description="The current release status of this PCR. "
+        "A PCR with valid_until in the past must have status Expired or Sunset; a PCR with valid_until "
+        "more than 5 years in the past must have status Sunset. Compliant systems should automatically "
+        "update these fields within 24 hours.",
+    )
     product_classes: dict[str, str | list[str]] = pyd.Field(
         description="List of classifications, including Masterformat and UNSPC", default_factory=dict
     )
+    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. Accepts "
+        "[2-letter country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), "
+        "[M49 region codes](https://unstats.un.org/unsd/methodology/m49/), "
+        'or the alias "EU27" for the 27 members of the Euro bloc, or the alias "NAFTA" '
+        "for the members of North American Free Trade Agreement",
+        example=["US", "CA", "MX", "EU27", "NAFTA"],
+    )
 
     @classmethod
     def get_asset_type(cls) -> str | None:

openepd/model/specs/README.md

@@ -0,0 +1,19 @@
+# Material Extensions
+
+This package contains openEPD material extensions. They are used to represent the material properties of the openEPD 
+materials, and are a more dynamic, frequently changing part of the standard. 
+
+## Versioning
+
+Extensions are versioned separately from the openEPD standard or openEPD API. 
+
+Each material extension is named after the corresponding EC3 product class, and is located in the relevant place 
+in the specs tree. For example, `RebarSteel` is nested under `Steel`. 
+
+Extensions are versioned as Major.Minor, for example "2.4". 
+
+Rules: 
+1. Minor versions for the same major version should be backwards compatible.
+2. Major versions are not compatible between themselves. 
+3. Pydantic models representing versions are named in a pattern SpecNameV1, where 1 is major version and SpecName is
+   the name of the material extension.

openepd/model/specs/__init__.py

@@ -1,5 +1,5 @@
 #
-#  Copyright 2023 by C Change Labs Inc. www.c-change-labs.com
+#  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.
@@ -17,13 +17,29 @@
 #  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
 #  Find out more at www.BuildingTransparency.org
 #
-import pydantic as pyd
 
+from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseOpenEpdSchema
-from openepd.model.specs.concrete import CmuSpec
+from openepd.model.specs import concrete, steel
+from openepd.model.specs.aluminium import AluminiumV1
+from openepd.model.specs.asphalt import AsphaltV1
+from openepd.model.specs.glass import GlazingV1
+from openepd.model.specs.wood import TimberV1
 
 
 class Specs(BaseOpenEpdSchema):
     """Material specific specs."""
 
-    cmu: CmuSpec | None = pyd.Field(default=None, description="Concrete Masonry Unit-specific (CMU) specs")
+    cmu: concrete.CmuSpec | None = pyd.Field(default=None, description="Concrete Masonry Unit-specific (CMU) specs")
+    CMU: concrete.CmuSpec | None = pyd.Field(default=None, description="Concrete Masonry Unit-specific (CMU) specs")
+    Concrete: concrete.ConcreteV1 | None = pyd.Field(
+        default=None, title="ConcreteV1", description="Concrete-specific specs"
+    )
+    PrecastConcrete: concrete.PrecastConcreteV1 | None = pyd.Field(
+        default=None, title="PrecastConcreteV1", description="Precast Concrete-specific specs"
+    )
+    Steel: steel.SteelV1 | None = pyd.Field(default=None, title="SteelV1", description="Steel-specific specs")
+    Asphalt: AsphaltV1 | None = pyd.Field(default=None, title="AsphaltV1")
+    Aluminium: AluminiumV1 | None = pyd.Field(default=None, title="AluminiumV1", description="Aluminium-specific specs")
+    Timber: TimberV1 | None = pyd.Field(default=None, title="TimberV1", description="Timber-specific specs")
+    Glazing: GlazingV1 | None = pyd.Field(default=None, title="GlazingV1", description="Glazing-specific specs")

openepd/model/specs/aluminium.py

@@ -0,0 +1,67 @@
+#
+#  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
+#
+from enum import StrEnum
+
+from openepd.compat.pydantic import pyd
+from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
+from openepd.model.validation.numbers import RatioFloat
+
+
+class AluminiumAlloy(StrEnum):
+    """Aluminium alloy enum."""
+
+    ALLOY_1xxx = ("1xxx",)
+    ALLOY_2xxx = ("2xxx",)
+    ALLOY_3xxx = ("3xxx",)
+    ALLOY_4xxx = ("4xxx",)
+    ALLOY_5xxx = ("5xxx",)
+    ALLOY_6xxx = ("6xxx",)
+    ALLOY_7xxx = ("7xxx",)
+    ALLOY_8xxx = ("8xxx",)
+    ALLOY_1xx_x = ("1xx.x",)
+    ALLOY_2xx_x = ("2xx.x",)
+    ALLOY_3xx_x = ("3xx.x",)
+    ALLOY_4xx_x = ("4xx.x",)
+    ALLOY_5xx_x = ("5xx.x",)
+    ALLOY_7xx_x = ("7xx.x",)
+    ALLOY_8xx_x = ("8xx.x",)
+    ALLOY_9xx_x = ("9xx.x",)
+
+
+class AluminiumExtrusionsV1(BaseOpenEpdHierarchicalSpec):
+    """Aluminium extrusions V1 spec."""
+
+    _EXT_VERSION = "1.0"
+
+    """Aluminium extrusions V1 spec."""
+    thermally_improved: bool | None = pyd.Field(default=None, description="Thermally improved")
+
+
+class AluminiumV1(BaseOpenEpdHierarchicalSpec):
+    """Aluminium V1 spec."""
+
+    _EXT_VERSION = "1.0"
+    recycled_content: RatioFloat | None = pyd.Field(default=None, description="Recycled content")
+
+    alloy: AluminiumAlloy | None = pyd.Field(default=None, description="Alloy")
+    anodized: bool | None = None
+    painted: bool | None = None
+
+    AluminiumExtrusions: AluminiumExtrusionsV1 | None = pyd.Field(title="AluminiumExtrusionsV1", default=None)

openepd/model/specs/asphalt.py

@@ -0,0 +1,87 @@
+#
+#  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
+#
+from enum import StrEnum
+
+from openepd.compat.pydantic import pyd
+from openepd.model.common import OpenEPDUnit
+from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
+from openepd.model.validation.numbers import RatioFloat
+from openepd.model.validation.quantity import LengthMmStr, TemperatureCStr, validate_unit_factory
+
+
+class AsphaltMixType(StrEnum):
+    """Asphalt mix type enum."""
+
+    HMA = "HMA"
+    WMA = "WMA"
+
+
+class AsphaltGradation(StrEnum):
+    """Asphalt gradation enum."""
+
+    Dense_graded = "Dense-graded"
+    Open_graded = "Open-graded"
+    Gap_graded = "Gap-graded"
+
+
+class AsphaltV1(BaseOpenEpdHierarchicalSpec):
+    """Asphalt spec."""
+
+    _EXT_VERSION = "1.0"
+
+    asphalt_aggregate_size_max: LengthMmStr | None = pyd.Field(
+        default=None, example="5mm", description="Max aggregate size"
+    )
+
+    asphalt_rap: RatioFloat | None = pyd.Field(
+        default=None, description="Percent of mixture that has been replaced by recycled " "asphalt pavement (RAP)."
+    )
+    asphalt_ras: RatioFloat | None = pyd.Field(
+        default=None, description="Percent of mixture that has been replaced by recycled " "asphalt shingles (RAS)."
+    )
+    asphalt_ground_tire_rubber: RatioFloat | None = pyd.Field(
+        default=None, description="Percent of mixture that has been replaced " "by ground tire rubber (GTR)."
+    )
+
+    asphalt_max_temperature: TemperatureCStr | None = pyd.Field(
+        default=None,
+        description="The upper threshold temperature to which an asphalt "
+        "binder can be heated preventing the asphalt mixture "
+        "from rutting",
+    )
+    asphalt_min_temperature: TemperatureCStr | None = pyd.Field(
+        default=None,
+        description="The lower threshold temperature for an asphalt "
+        "binder to prevent thermal cracking of the asphalt"
+        " mixture.",
+    )
+
+    asphalt_mix_type: AsphaltMixType | None = pyd.Field(default=None, description="Asphalt mix type")
+    asphalt_gradation: AsphaltGradation | None = pyd.Field(default=None, description="Asphalt gradation")
+
+    asphalt_sbr: bool | None = pyd.Field(default=None, description="Styrene-butadiene rubber (SBR)")
+    asphalt_sbs: bool | None = pyd.Field(default=None, description="Styrene-butadiene-styrene (SBS)")
+    asphalt_ppa: bool | None = pyd.Field(default=None, description="Polyphosphoric acid (PPA)")
+    asphalt_gtr: bool | None = pyd.Field(default=None, description="Ground tire rubber (GTR)")
+    asphalt_pmb: bool | None = pyd.Field(default=None, description="Polymer modified bitumen (PMB)")
+
+    _aggregate_size_max_validator = pyd.validator("asphalt_aggregate_size_max", allow_reuse=True)(
+        validate_unit_factory(OpenEPDUnit.m)
+    )

openepd/model/specs/base.py

@@ -0,0 +1,60 @@
+#
+#  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
+#
+from typing import Any
+
+from openepd.compat.pydantic import pyd
+from openepd.model.base import BaseOpenEpdSchema, Version
+from openepd.model.validation.common import validate_version_compatibility, validate_version_format
+from openepd.model.validation.quantity import QuantityValidator
+from openepd.model.versioning import WithExtVersionMixin
+
+
+class BaseOpenEpdSpec(BaseOpenEpdSchema):
+    """Base class for all OpenEPD specs."""
+
+    class Config:
+        use_enum_values = False  # we need to store enums as strings and not values
+
+
+class BaseOpenEpdHierarchicalSpec(BaseOpenEpdSpec, WithExtVersionMixin):
+    """Base class for new specs (hierarchical, versioned)."""
+
+    # external validator for quantities (e.g. length, mass, etc.) which should be setup by the user of the library.
+    _QUANTITY_VALIDATOR: QuantityValidator | None = None
+
+    def __init__(self, **data: Any) -> None:
+        # ensure that all the concrete spec objects fail on creations if they dont have _EXT_VERSION declared to
+        # something meaningful
+        if not hasattr(self, "_EXT_VERSION") or self._EXT_VERSION is None:
+            raise ValueError(f"Class {self.__class__} must declare an extension version")
+        Version.parse_version(self._EXT_VERSION)  # validate format correctness
+        super().__init__(**{"ext_version": self._EXT_VERSION, **data})
+
+    _version_format_validator = pyd.validator("ext_version", allow_reuse=True, check_fields=False)(
+        validate_version_format
+    )
+    _version_major_match_validator = pyd.validator("ext_version", allow_reuse=True, check_fields=False)(
+        validate_version_compatibility("_EXT_VERSION")
+    )
+
+
+def setup_external_validators(quantity_validator: QuantityValidator):
+    """Set the implementation unit validator for specs."""
+    BaseOpenEpdHierarchicalSpec._QUANTITY_VALIDATOR = quantity_validator