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

openepd/model/specs/concrete.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,10 +18,16 @@
 #  Find out more at www.BuildingTransparency.org
 #
 from enum import StrEnum
+from typing import Literal
 
-import pydantic as pyd
-
-from openepd.model.base import BaseOpenEpdSpec
+from openepd.compat.pydantic import pyd
+from openepd.model.base import BaseOpenEpdSchema
+from openepd.model.common import OpenEPDUnit
+from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec, BaseOpenEpdSpec
+from openepd.model.specs.generated.enums import AciExposureClass, CsaExposureClass, EnExposureClass
+from openepd.model.validation.common import together_validator
+from openepd.model.validation.numbers import RatioFloat
+from openepd.model.validation.quantity import LengthMmStr, PressureMPaStr, validate_unit_factory
 
 
 class CmuWeightClassification(StrEnum):
@@ -35,55 +41,313 @@ class CmuWeightClassification(StrEnum):
     """Lightweight CMU has a density less than 105 lbs/cu. ft."""
 
 
-class CmuOptions(BaseOpenEpdSpec):
+class CmuOptions(BaseOpenEpdSchema):
     """Concrete Masonry Unit options."""
 
     load_bearing: bool | None = pyd.Field(
         description="Load-Bearing. CMUs intended to be loadbearing, rather than simply cosmetic",
+        example=True,
         default=None,
-        json_schema_extra={"example": True},
     )
     aerated_concrete: bool | None = pyd.Field(
-        description="AAC Aerated Concrete. Aerated Autoclaved Concrete, a foam concrete.",
-        default=None,
-        json_schema_extra={"example": True},
+        description="AAC Aerated Concrete. Aerated Autoclaved Concrete, a foam concrete.", example=True, default=None
     )
     insulated: bool | None = pyd.Field(
-        description="Insulated. CMUs with integral insulation",
-        default=None,
+        description="Insulated. CMUs with integral insulation", example=True, default=None
     )
     sound_absorbing: bool | None = pyd.Field(
-        description="Sound Absorbing. CMUs structured for sound absorbtion",
-        default=None,
+        description="Sound Absorbing. CMUs structured for sound absorbtion", example=True, default=None
     )
     white: bool | None = pyd.Field(
-        description="White. CMU using white cement and light-colored aggregate",
-        default=None,
+        description="White. CMU using white cement and light-colored aggregate", example=True, default=None
     )
     recycled_aggregate: bool | None = pyd.Field(
-        description="Recycled aggregate. CMU using primarily reycled aggregates",
-        default=None,
+        description="Recycled aggregate. CMU using primarily reycled aggregates", example=True, default=None
     )
     groundface: bool | None = pyd.Field(
-        description="Ground Face. Ground or Honed facing, typically for improved appearance", default=None
+        description="Ground Face. Ground or Honed facing, typically for improved appearance", example=True, default=None
     )
     splitface: bool | None = pyd.Field(
-        description="Splitface. Rough surface texture via splitting; aggregate can be seen", default=None
+        description="Splitface. Rough surface texture via splitting; aggregate can be seen", example=True, default=None
+    )
+    smoothface: bool | None = pyd.Field(
+        description="Smooth Face. Standard smooth-faced blocks", example=True, default=None
     )
-    smoothface: bool | None = pyd.Field(description="Smooth Face. Standard smooth-faced blocks", default=None)
     slumpstone: bool | None = pyd.Field(
         description="Slumpstone. A slightly rounded, random distortion with the look of rustic adobe.",
+        example=True,
+        default=None,
+    )
+
+
+class ConcreteTypicalApplication(BaseOpenEpdSpec):
+    """Typical Application for Concrete."""
+
+    fnd: bool | None = pyd.Field(
+        description="Foundation. Typically used in direct contact with soil, e.g. footings, piles, mass concrete, "
+        "mat foundations, and similar applications.",
+        example=True,
+        default=None,
+    )
+    sog: bool | None = pyd.Field(
+        description="Slab on Grade. Typically used in continuously supported horizontal "
+        "applications e.g. slab on grade, topping slabs, sidewalks, and roadways.",
+        example=True,
+        default=None,
+    )
+    hrz: bool | None = pyd.Field(
+        description="Elevated Horizontal. Typically used in elevated horizontal applications, either on metal deck or "
+        "where soffit formwork must be removed, e.g. post-tension plates, rebar plates, beams and slabs, "
+        "waffle slabs.",
+        example=True,
+        default=None,
+    )
+    vrt_wall: bool | None = pyd.Field(description="Vertical Wall.", example=True, default=None)
+    vrt_column: bool | None = pyd.Field(description="Vertical Column.", example=True, default=None)
+    vrt_other: bool | None = pyd.Field(
+        description="Vertical Other. Typically used in vertical applications other than "
+        "walls or columns, e.g. sloped surfaces where formwork is required "
+        "on multiple faces.",
+        example=True,
+        default=None,
+    )
+    sht: bool | None = pyd.Field(
+        description="Shotcrete. Pneumatically applied, without formwork on all sides.", example=True, default=None
+    )
+    cdf: bool | None = pyd.Field(
+        description="Flowable Fill (CDF). Typically used to fill voids, backfill retaining "
+        "walls, as a sub-base, and similar applications. Also called Controlled "
+        "Density Fill (CDF) or Controlled Low Strength Materials (CLSM).",
+        example=True,
+        default=None,
+    )
+    sac: bool | None = pyd.Field(
+        description="Typically used in concrete sidewalks and barrier curbs.", example=True, default=None
+    )
+    pav: bool | None = pyd.Field(description="Typically used in pervious concrete", example=True, default=None)
+    oil: bool | None = pyd.Field(
+        description="Concretes for use in creation, maintenance, and decommissioning of "
+        "petroleum extraction wells and similar applications. Includes foamed "
+        "cement; often called cement in the drilling industry. Differs from "
+        "flowable fill and grout in that it contains no sand or other aggregates.",
+        example=True,
+        default=None,
+    )
+    grt: bool | None = pyd.Field(
+        description="Cement grouting is a slurry that is placed as a flowable liquid. It is "
+        "an effective material for filling and strengthening granular soils, "
+        "voids in rocks, foundation underpinnings, and other underground voids. "
+        "Also called structural grout, these materials typically impart"
+        " significant strength to the system",
+        example=True,
         default=None,
     )
+    ota: bool | None = pyd.Field(
+        description="Typical application not covered by other values.", example=True, default=None
+    )
 
 
 class CmuSpec(BaseOpenEpdSpec):
     """Standardized Concrete Masonry Unit-specific extension for OpenEPD."""
 
-    strength: str = pyd.Field(
-        description="Compressive strength",
-        json_schema_extra=dict(example="4000 psi"),
-    )
+    strength: str = pyd.Field(description="Compressive strength", example="4000 psi")
     options: CmuOptions = pyd.Field(
         description="Options for CMU. List of true/false properties", default_factory=CmuOptions
     )
+
+
+class Cementitious(BaseOpenEpdSchema):
+    """List of cementitious materials, and proportion by mass."""
+
+    opc: RatioFloat | None = pyd.Field(default=None, description="Ordinary Gray Portland Cement")
+    wht: RatioFloat | None = pyd.Field(default=None, description="White Portland Cement")
+    ggbs: RatioFloat | None = pyd.Field(default=None, description="Ground Granulated Blast Furnace Slag")
+    flyAsh: RatioFloat | None = pyd.Field(default=None, description="Fly Ash, including types F, CL, and CH")
+    siFume: RatioFloat | None = pyd.Field(default=None, description="Silica Fume")
+    gg45: RatioFloat | None = pyd.Field(default=None, description="Ground Glass, 45um or smaller")
+    natPoz: RatioFloat | None = pyd.Field(default=None, description="Natural pozzolan")
+    mk: RatioFloat | None = pyd.Field(default=None, description="Metakaolin")
+    CaCO3: RatioFloat | None = pyd.Field(default=None, description="Limestone")
+    other: RatioFloat | None = pyd.Field(default=None, description="Other SCMs")
+
+
+class TypicalApplication(BaseOpenEpdSchema):
+    """Concrete typical application."""
+
+    fnd: bool | None = pyd.Field(description="Foundation", default=None)
+    sog: bool | None = pyd.Field(description="Slab on Grade", default=None)
+    hrz: bool | None = pyd.Field(description="Elevated Horizontal", default=None)
+    vrt_wall: bool | None = pyd.Field(description="Vertical Wall", default=None)
+    vrt_column: bool | None = pyd.Field(description="Vertical Column", default=None)
+    vrt_other: bool | None = pyd.Field(description="Vertical Other", default=None)
+    sht: bool | None = pyd.Field(description="Shotcrete", default=None)
+    cdf: bool | None = pyd.Field(description="Flowable Fill (CDF,default=None)", default=None)
+    sac: bool | None = pyd.Field(description="Sidewalk and Curb", default=None)
+    pav: bool | None = pyd.Field(description="Paving", default=None)
+    oil: bool | None = pyd.Field(description="Oil Patch", default=None)
+    grt: bool | None = pyd.Field(description="Cement Grout", default=None)
+    ota: bool | None = pyd.Field(description="Other", default=None)
+
+
+class ConcreteV1Options(BaseOpenEpdSchema):
+    """Concrete options."""
+
+    lightweight: bool | None = pyd.Field(description="Lightweight", default=None)
+    plc: bool | None = pyd.Field(description="Portland Limestone Cement", default=None)
+    scc: bool | None = pyd.Field(description="Self Compacting", default=None)
+    finishable: bool | None = pyd.Field(description="Finishable", default=None)
+    air: bool | None = pyd.Field(description="Air Entrainment", default=None)
+    co2: bool | None = pyd.Field(description="CO2 Curing", default=None)
+    white: bool | None = pyd.Field(description="White Cement", default=None)
+    fiber_reinforced: bool | None = pyd.Field(description="Fiber reinforced", default=None)
+
+
+class ReadyMixV1(BaseOpenEpdHierarchicalSpec):
+    """Concretes to be mixed and then poured on-site."""
+
+    _EXT_VERSION = "1.0"
+
+
+class FlowableFillV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Flowable fill is a slurry that is placed as a flowable liquid (high slump) and sets with no compaction.
+
+    It is often used in tight or restricted access areas where placing and compacting
+    fill is difficult. Applications include filling large voids such as abandoned underground storage
+    tanks, basements, tunnels, mines, and sewers. It can also be used as paving sub-base, bridge
+    abutment, and retaining wall backfill. Also called Controlled Density Fill (CDF) or Controlled
+    Low Strength Materials (CLSMs). These materials typically have compressive strengths
+    under 1200 psi.
+    """
+
+    _EXT_VERSION = "1.0"
+
+
+class OilPatchV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Concretes for use in petroleum extraction wells and similar applications.
+
+    Includes foamed cement; often called cement in the drilling industry. Differs from
+    flowable fill and grout in that it contains no sand or other aggregates.
+    """
+
+    _EXT_VERSION = "1.0"
+
+
+class ConcretePavingV1(BaseOpenEpdHierarchicalSpec):
+    """Concrete paving."""
+
+    _EXT_VERSION = "1.0"
+
+
+class ShotcreteV1(BaseOpenEpdHierarchicalSpec):
+    """Concretes sprayed on a target."""
+
+    _EXT_VERSION = "1.0"
+
+
+class CementGroutV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Cement grouting is a slurry that is placed as a flowable liquid.
+
+    It is an effective material for filling and
+    strengthening granular soils, voids in rocks, foundation underpinnings, and other underground voids. Also called
+    structural grout, these materials typically impart significant compressive strength to the system.
+
+    """
+
+    _EXT_VERSION = "1.0"
+
+
+class ConcreteV1(BaseOpenEpdHierarchicalSpec):
+    """Concrete spec."""
+
+    _EXT_VERSION = "1.0"
+
+    strength_28d: PressureMPaStr | None = pyd.Field(
+        default=None, example="30 MPa", description="Concrete strength after 28 days"
+    )
+    strength_early: PressureMPaStr | None = pyd.Field(
+        default=None,
+        example="30 MPa",
+        description="A strength spec which is to be reached earlier than 28 days (e.g. 3d)",
+    )
+    strength_early_d: Literal[3, 7, 14] | None = pyd.Field(default=None, description="Test Day for the Early Strength")
+    strength_late: PressureMPaStr | None = pyd.Field(
+        default=None,
+        example="30 MPa",
+        description="A strength spec which is to be reached later than 28 days (e.g. 42d)",
+    )
+    strength_late_d: Literal[42, 56, 72, 96, 120] | None = pyd.Field(
+        default=None, description="Test Day for the Late Strength"
+    )
+    slump: LengthMmStr | None = pyd.Field(description="Minimum test slump", example="40 mm", default=None)
+    w_c_ratio: RatioFloat | None = pyd.Field(description="Ratio of water to cement", example=0.3, default=None)
+    aci_exposure_classes: list[AciExposureClass] = pyd.Field(
+        description=(AciExposureClass.__doc__ or "").lstrip(), default_factory=list
+    )
+    csa_exposure_classes: list[CsaExposureClass] = pyd.Field(
+        description=(CsaExposureClass.__doc__ or "").lstrip(), default_factory=list
+    )
+    en_exposure_classes: list[EnExposureClass] = pyd.Field(
+        description=(EnExposureClass.__doc__ or "").lstrip(), default_factory=list
+    )
+    cementitious: Cementitious | None = pyd.Field(
+        default=None,
+        description="List of cementitious materials, and proportion by mass. Each field is 0 to 1.",
+    )
+    application: TypicalApplication | None = pyd.Field(description="Typical Application", default=None)
+    options: ConcreteV1Options | None = pyd.Field(description="Concrete options", default=None)
+
+    # Nested specs
+    ReadyMix: ReadyMixV1 | None = None
+    FlowableFill: FlowableFillV1 | None = None
+    OilPatch: OilPatchV1 | None = None
+    ConcretePaving: ConcretePavingV1 | None = None
+    Shotcrete: ShotcreteV1 | None = None
+    CementGrout: CementGroutV1 | None = None
+
+    _compressive_strength_unit_validator = pyd.validator("strength_28d", allow_reuse=True, check_fields=False)(
+        validate_unit_factory(OpenEPDUnit.MPa)
+    )
+    _strength_early_unit_validator = pyd.validator("strength_early", allow_reuse=True)(
+        validate_unit_factory(OpenEPDUnit.MPa)
+    )
+    _strength_late_unit_validator = pyd.validator("strength_late", allow_reuse=True)(
+        validate_unit_factory(OpenEPDUnit.MPa)
+    )
+
+    @pyd.root_validator
+    def _late_validator(cls, values):
+        together_validator("strength_late", "strength_late_d", values)
+        return values
+
+    @pyd.root_validator
+    def _early_validator(cls, values):
+        together_validator("strength_early", "strength_early_d", values)
+        return values
+
+
+class PrecastConcreteV1(BaseOpenEpdHierarchicalSpec):
+    """Precast Concrete spec."""
+
+    _EXT_VERSION = "1.0"
+
+    strength_28d: PressureMPaStr | None = pyd.Field(
+        default=None, example="30 MPa", description="Concrete strength after 28 days"
+    )
+
+    lightweight: bool | None = pyd.Field(description="Lightweight", default=None)
+    steel_mass_percentage: RatioFloat | None = pyd.Field(
+        default=None,
+        description="Percent of total mass that is steel reinforcement. Steel reinforcement "
+        "substantially changes functional performance and usually adds substantial GWP "
+        "per declared unit.",
+    )
+
+    insulated: bool | None = pyd.Field(description="Insulated", default=None)
+    gfrc: bool | None = pyd.Field(description="Glass Fiber Reinforced Concrete", default=None)
+
+    _compressive_strength_unit_validator = pyd.validator("strength_28d", allow_reuse=True)(
+        validate_unit_factory(OpenEPDUnit.MPa)
+    )

openepd/model/specs/generated/accessories.py

@@ -0,0 +1,63 @@
+#
+#  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 openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
+
+
+class BlanketFacingV1(BaseOpenEpdHierarchicalSpec):
+    """Blanket facing performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class DoorsHardwareV1(BaseOpenEpdHierarchicalSpec):
+    """Doors hardware performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class FlooringAccessoriesV1(BaseOpenEpdHierarchicalSpec):
+    """Flooring accessories performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class MortarV1(BaseOpenEpdHierarchicalSpec):
+    """Mortar performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class TileGroutV1(BaseOpenEpdHierarchicalSpec):
+    """Tile grout performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class AccessoriesV1(BaseOpenEpdHierarchicalSpec):
+    """Accessories performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    # Nested specs:
+    BlanketFacing: BlanketFacingV1 | None = None
+    DoorsHardware: DoorsHardwareV1 | None = None
+    FlooringAccessories: FlooringAccessoriesV1 | None = None
+    Mortar: MortarV1 | None = None
+    TileGrout: TileGroutV1 | None = None

openepd/model/specs/generated/aggregates.py

@@ -0,0 +1,71 @@
+#
+#  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 openepd.compat.pydantic import pyd
+from openepd.model.base import BaseOpenEpdSchema
+from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
+from openepd.model.specs.generated.enums import AggregateGradation, AggregateWeightClassification
+from openepd.model.validation.numbers import RatioFloat
+from openepd.model.validation.quantity import LengthMmStr
+
+
+class AggregateApplication(BaseOpenEpdSchema):
+    """Application for aggregates."""
+
+    concrete: bool | None = pyd.Field(default=None, description="Aggregates used in concrete and masonry applications")
+    asphalt: bool | None = pyd.Field(
+        default=None, description="Aggregates used in bituminous paving and surface applications"
+    )
+    unbound: bool | None = pyd.Field(default=None)
+
+
+class AggregatesV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Construction Aggregates.
+
+    Includes sand, gravel, crushed stone, etc. for use as bases, ballasts, or as a component in concrete or asphalt.
+    """
+
+    _EXT_VERSION = "1.0"
+
+    # Own fields:
+    recycled_content: RatioFloat | None = pyd.Field(
+        example=0.3, default=None, description="Percent of total mass that is recycled aggregate"
+    )
+    nominal_max_size: LengthMmStr | None = pyd.Field(
+        default=None,
+        example="10 mm",
+        description="Nominal maximum aggregate size is defined as one sieve size smaller than the maximum "
+        "aggregate size. "
+        "The maximum aggregate size is defined as the smallest sieve size that requires 100% passing.",
+    )
+    weight_classification: AggregateWeightClassification | None = pyd.Field(
+        example=str(AggregateWeightClassification.HEAVY_WEIGHT), default=None
+    )
+    gradation: AggregateGradation | None = pyd.Field(example=str(AggregateGradation.GAP), default=None)
+    manufactured: bool | None = pyd.Field(
+        default=None,
+        description="Aggregate produced via expansion or sintering at high temperatures of the following materials: "
+        "clay, shale, slate, perlite, vermiculite, or slag. Typically used to produce lightweight aggregate",
+    )
+    slag: bool | None = pyd.Field(
+        default=None,
+        description="Pelletized, foamed, and granulated blast furnace slag can be used as construction aggregate.",
+    )
+    application: AggregateApplication | None = None

openepd/model/specs/generated/aluminium.py

@@ -0,0 +1,66 @@
+#
+#  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 openepd.compat.pydantic import pyd
+from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
+from openepd.model.specs.generated.enums import AluminiumAlloy
+
+
+class AluminiumBilletsV1(BaseOpenEpdHierarchicalSpec):
+    """Aluminium billets performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class AluminiumExtrusionsV1(BaseOpenEpdHierarchicalSpec):
+    """Aluminium extrusions performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    # Own fields:
+    thermally_improved: bool | None = pyd.Field(default=None, description="", example=True)
+
+
+class AluminiumSheetGoodsV1(BaseOpenEpdHierarchicalSpec):
+    """Aluminium sheet goods performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class AluminiumSuspensionAssemblyV1(BaseOpenEpdHierarchicalSpec):
+    """Aluminium suspension assembly performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class AluminiumV1(BaseOpenEpdHierarchicalSpec):
+    """Material definition for objects made primarily from Aluminium and its alloys."""
+
+    _EXT_VERSION = "1.0"
+
+    # Own fields:
+    alloy: AluminiumAlloy | None = pyd.Field(default=None, description="", example=str(AluminiumAlloy.ALLOY_1XXX))
+    anodized: bool | None = pyd.Field(default=None, description="", example=True)
+    painted: bool | None = pyd.Field(default=None, description="", example=True)
+
+    # Nested specs:
+    AluminiumBillets: AluminiumBilletsV1 | None = None
+    AluminiumExtrusions: AluminiumExtrusionsV1 | None = None
+    AluminiumSheetGoods: AluminiumSheetGoodsV1 | None = None
+    AluminiumSuspensionAssembly: AluminiumSuspensionAssemblyV1 | None = None

openepd/model/specs/generated/asphalt.py

@@ -0,0 +1,86 @@
+#
+#  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 openepd.compat.pydantic import pyd
+from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
+from openepd.model.specs.generated.enums import AsphaltGradation, AsphaltMixType
+from openepd.model.validation.numbers import RatioFloat
+from openepd.model.validation.quantity import LengthMmStr, TemperatureCStr, validate_unit_factory
+
+
+class AsphaltV1(BaseOpenEpdHierarchicalSpec):
+    """Asphalt performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    # Own fields:
+    aggregate_size_max: LengthMmStr | None = pyd.Field(default=None, description="Max aggregate size", example="20 mm")
+    rap: RatioFloat | None = pyd.Field(
+        default=None,
+        description="Percent of mixture that has been replaced by recycled asphalt pavement (RAP).",
+        example=0.5,
+        ge=0,
+        le=1,
+    )
+    ras: RatioFloat | None = pyd.Field(
+        default=None,
+        description="Percent of mixture that has been replaced by recycled asphalt shingles (RAS).",
+        example=0.5,
+        ge=0,
+        le=1,
+    )
+    ground_tire_rubber: RatioFloat | None = pyd.Field(
+        default=None,
+        description="Percent of mixture that has been replaced by ground tire rubber (GTR).",
+        example=0.5,
+        ge=0,
+        le=1,
+    )
+    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",
+        example="90 °C",
+    )
+    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.",
+        example="-20 °C",
+    )
+    mix_type: AsphaltMixType | None = pyd.Field(default=None, description="Asphalt mix type", example="WMA")
+    gradation: AsphaltGradation | None = pyd.Field(default=None, description="Asphalt gradation", example="Gap-graded")
+
+    sbr: bool | None = pyd.Field(default=None, description="Styrene-butadiene rubber (SBR)", example=True)
+    sbs: bool | None = pyd.Field(default=None, description="Styrene-butadiene-styrene (SBS)", example=True)
+    ppa: bool | None = pyd.Field(default=None, description="Polyphosphoric acid (PPA)", example=True)
+    gtr: bool | None = pyd.Field(default=None, description="Ground tire rubber (GTR)", example=True)
+    pmb: bool | None = pyd.Field(default=None, description="Polymer modified bitumen (PMB)", example=True)
+
+    _asphalt_aggregate_size_max_is_quantity_validator = pyd.validator("aggregate_size_max", allow_reuse=True)(
+        validate_unit_factory("m")
+    )
+    _asphalt_max_temperature_is_quantity_validator = pyd.validator("max_temperature", allow_reuse=True)(
+        validate_unit_factory("°C")
+    )
+    _asphalt_min_temperature_is_quantity_validator = pyd.validator("min_temperature", allow_reuse=True)(
+        validate_unit_factory("°C")
+    )

openepd/model/specs/generated/bulk_materials.py

@@ -0,0 +1,26 @@
+#
+#  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 openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
+
+
+class BulkMaterialsV1(BaseOpenEpdHierarchicalSpec):
+    """Bulk materials performance specification."""
+
+    _EXT_VERSION = "1.0"