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

openepd/model/specs/generated/cladding.py

@@ -0,0 +1,214 @@
+#
+#  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 CladdingFacingMaterial, CladdingInsulatingMaterial, SidingFormFactor
+from openepd.model.validation.quantity import LengthMmStr, LengthMStr, validate_unit_factory
+
+
+class AluminiumSidingV1(BaseOpenEpdHierarchicalSpec):
+    """Aluminium siding performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class SteelSidingV1(BaseOpenEpdHierarchicalSpec):
+    """Steel siding performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class ZincSidingV1(BaseOpenEpdHierarchicalSpec):
+    """Zinc siding performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class ShingleAndShakeSidingV1(BaseOpenEpdHierarchicalSpec):
+    """Shingle and shake siding performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class MetalSidingV1(BaseOpenEpdHierarchicalSpec):
+    """Metal siding performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    # Nested specs:
+    AluminiumSiding: AluminiumSidingV1 | None = None
+    SteelSiding: SteelSidingV1 | None = None
+    ZincSiding: ZincSidingV1 | None = None
+
+
+class CompositionSidingV1(BaseOpenEpdHierarchicalSpec):
+    """Composition siding performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class FiberCementSidingV1(BaseOpenEpdHierarchicalSpec):
+    """Fiber cement siding performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class InsulatedVinylSidingV1(BaseOpenEpdHierarchicalSpec):
+    """Insulated vinyl siding performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    # Own fields:
+    thickness: LengthMmStr | None = pyd.Field(default=None, description="", example="1 mm")
+
+    _vinyl_siding_thickness_is_quantity_validator = pyd.validator("thickness", allow_reuse=True)(
+        validate_unit_factory("m")
+    )
+
+
+class PlywoodSidingV1(BaseOpenEpdHierarchicalSpec):
+    """Plywood siding performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class PolypropyleneSidingV1(BaseOpenEpdHierarchicalSpec):
+    """Polypropylene siding performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class SolidWoodSidingV1(BaseOpenEpdHierarchicalSpec):
+    """Solid wood siding performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    # Nested specs:
+    ShingleAndShakeSiding: ShingleAndShakeSidingV1 | None = None
+
+
+class VinylSidingV1(BaseOpenEpdHierarchicalSpec):
+    """Vinyl siding performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    # Own fields:
+    thickness: LengthMmStr | None = pyd.Field(default=None, description="", example="5 mm")
+
+    _vinyl_siding_thickness_is_quantity_validator = pyd.validator("thickness", allow_reuse=True)(
+        validate_unit_factory("m")
+    )
+
+
+class SidingV1(BaseOpenEpdHierarchicalSpec):
+    """Siding performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    # Own fields:
+    insulated: bool | None = pyd.Field(default=None, description="", example=True)
+    ventilated: bool | None = pyd.Field(default=None, description="", example=True)
+    paint_or_stain_required: bool | None = pyd.Field(default=None, description="", example=True)
+    r_value: str | None = pyd.Field(default=None, description="", example="1 K * m2 / W")
+    form_factor: SidingFormFactor | None = pyd.Field(default=None, description="", example="Lap")
+
+    _siding_r_value_is_quantity_validator = pyd.validator("r_value", allow_reuse=True)(
+        validate_unit_factory("K * m2 / W")
+    )
+
+    # Nested specs:
+    MetalSiding: MetalSidingV1 | None = None
+    CompositionSiding: CompositionSidingV1 | None = None
+    FiberCementSiding: FiberCementSidingV1 | None = None
+    InsulatedVinylSiding: InsulatedVinylSidingV1 | None = None
+    PlywoodSiding: PlywoodSidingV1 | None = None
+    PolypropyleneSiding: PolypropyleneSidingV1 | None = None
+    SolidWoodSiding: SolidWoodSidingV1 | None = None
+    VinylSiding: VinylSidingV1 | None = None
+
+
+class InsulatedRoofPanelsV1(BaseOpenEpdHierarchicalSpec):
+    """Insulated roof panels performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    # Own fields:
+    r_value: str | None = pyd.Field(default=None, description="", example="1 K * m2 / W")
+    insulating_material: CladdingInsulatingMaterial | None = pyd.Field(
+        default=None, description="", example="No Insulation"
+    )
+
+    _cladding_r_value_is_quantity_validator = pyd.validator("r_value", allow_reuse=True)(
+        validate_unit_factory("K * m2 / W")
+    )
+
+
+class InsulatedWallPanelsV1(BaseOpenEpdHierarchicalSpec):
+    """Insulated wall panels performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    # Own fields:
+    r_value: str | None = pyd.Field(default=None, description="", example="1 K * m2 / W")
+    insulating_material: CladdingInsulatingMaterial | None = pyd.Field(
+        default=None, description="", example="No Insulation"
+    )
+
+    _cladding_r_value_is_quantity_validator = pyd.validator("r_value", allow_reuse=True)(
+        validate_unit_factory("K * m2 / W")
+    )
+
+
+class RoofPanelsV1(BaseOpenEpdHierarchicalSpec):
+    """Roof panels performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class StoneCladdingV1(BaseOpenEpdHierarchicalSpec):
+    """Stone cladding performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class WallPanelsV1(BaseOpenEpdHierarchicalSpec):
+    """Wall panels performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class CladdingV1(BaseOpenEpdHierarchicalSpec):
+    """Cladding performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    # Own fields:
+    thickness: LengthMStr | None = pyd.Field(default=None, description="", example="10 mm")
+    facing_material: CladdingFacingMaterial | None = pyd.Field(default=None, description="", example="Steel")
+
+    _thickness_is_quantity_validator = pyd.validator("thickness", allow_reuse=True)(validate_unit_factory("m"))
+
+    # Nested specs:
+    Siding: SidingV1 | None = None
+    InsulatedRoofPanels: InsulatedRoofPanelsV1 | None = None
+    InsulatedWallPanels: InsulatedWallPanelsV1 | None = None
+    RoofPanels: RoofPanelsV1 | None = None
+    StoneCladding: StoneCladdingV1 | None = None
+    WallPanels: WallPanelsV1 | None = None

openepd/model/specs/generated/cmu.py

@@ -0,0 +1,46 @@
+#
+#  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 CmuBlockType, CmuWeightClassification
+from openepd.model.validation.quantity import GwpKgCo2eStr, PressureMPaStr, validate_unit_factory
+
+
+class CMUV1(BaseOpenEpdHierarchicalSpec):
+    """CMU performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    # Own fields:
+    white_cement: bool | None = pyd.Field(default=None, description="", example=True)
+    strength_28d: PressureMPaStr | None = pyd.Field(default=None, description="", example="1 MPa")
+    weight_classification: CmuWeightClassification | None = pyd.Field(default=None, description="", example="Normal")
+    block_type: CmuBlockType | None = pyd.Field(default=None, description="", example="Gray")
+    insulated: bool | None = pyd.Field(default=None, description="", example=True)
+    sound_performance: bool | None = pyd.Field(default=None, description="", example=True)
+    b1_recarbonation: GwpKgCo2eStr | None = pyd.Field(default=None, description="", example="1 kgCO2e")
+    b1_recarbonation_z: float | None = pyd.Field(default=None, description="", example=2.3)
+
+    _concrete_compressive_strength_28d_is_quantity_validator = pyd.validator("strength_28d", allow_reuse=True)(
+        validate_unit_factory("MPa")
+    )
+    _b1_recarbonation_is_quantity_validator = pyd.validator("b1_recarbonation", allow_reuse=True)(
+        validate_unit_factory("kgCO2e")
+    )

openepd/model/specs/generated/common.py

@@ -0,0 +1,27 @@
+#
+#  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.base import BaseOpenEpdSchema
+from openepd.model.org import OrgRef
+
+
+class HasForestPracticesCertifiers(BaseOpenEpdSchema):
+    """An interface for models which are linked to forest practices certifiers."""
+
+    forest_practices_certifiers: list[OrgRef] | None

openepd/model/specs/generated/concrete.py

@@ -0,0 +1,151 @@
+#
+#  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 Literal
+
+from openepd.compat.pydantic import pyd
+from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
+from openepd.model.specs.concrete import Cementitious, ConcreteTypicalApplication
+from openepd.model.specs.generated.enums import AciExposureClass, CsaExposureClass, EnExposureClass
+from openepd.model.validation.numbers import RatioFloat
+from openepd.model.validation.quantity import (
+    LengthInchStr,
+    LengthMmStr,
+    MassKgStr,
+    PressureMPaStr,
+    validate_unit_factory,
+)
+
+
+class CementGroutV1(BaseOpenEpdHierarchicalSpec):
+    """Cement grout performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class ConcretePavingV1(BaseOpenEpdHierarchicalSpec):
+    """Concrete paving performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    # Own fields:
+    flexion_strength: PressureMPaStr | None = pyd.Field(
+        default=None, description="Paving flexion strength", example="30 MPa"
+    )
+
+    _concrete_flexion_strength_is_quantity_validator = pyd.validator("flexion_strength", allow_reuse=True)(
+        validate_unit_factory("MPa")
+    )
+
+
+class FlowableFillV1(BaseOpenEpdHierarchicalSpec):
+    """Flowable fill performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class OilPatchV1(BaseOpenEpdHierarchicalSpec):
+    """Oil patch performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class ReadyMixV1(BaseOpenEpdHierarchicalSpec):
+    """Concretes that are mixed just before use, and then poured on-site into forms."""
+
+    _EXT_VERSION = "1.0"
+
+
+class ShotcreteV1(BaseOpenEpdHierarchicalSpec):
+    """Shotcrete performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+
+class ConcreteV1(BaseOpenEpdHierarchicalSpec):
+    """Concrete performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    # Own fields:
+    lightweight: bool | None = pyd.Field(default=None, description="Lightweight", example=True)
+
+    strength_28d: PressureMPaStr | None = pyd.Field(
+        default=None, description="Concrete strength after 28 days", example="1 MPa"
+    )
+    strength_other: PressureMPaStr | None = pyd.Field(
+        default=None,
+        description="A strength spec which is to be reached later other 28 days (e.g. 42d)",
+        example="30 MPa",
+    )
+    strength_other_d: Literal[3, 7, 14, 42, 56, 72, 96, 120] | None = pyd.Field(
+        default=None, description="Test Day for the Late Strength", example=42
+    )
+
+    slump: LengthInchStr | None = pyd.Field(default=None, description="", example="2 in")
+    min_slump: LengthInchStr | None = pyd.Field(default=None, description="Minimum test slump", example="2 in")
+    max_slump: LengthInchStr | None = pyd.Field(default=None, description="", example="2 in")
+
+    min_pipeline_size: LengthMmStr | None = pyd.Field(default=None, description="", example="200 mm")
+    w_c_ratio: RatioFloat | None = pyd.Field(
+        default=None, description="Ratio of water to cement", example=0.5, ge=0, le=1
+    )
+    air_entrain: bool | None = pyd.Field(default=None, description="Air Entrainment", example=True)
+    co2_entrain: bool | None = pyd.Field(default=None, description="CO2 Curing", example=True)
+    self_consolidating: bool | None = pyd.Field(default=None, description="Self Compacting", example=True)
+    white_cement: bool | None = pyd.Field(default=None, description="White Cement", example=True)
+    plc: bool | None = pyd.Field(default=None, description="Portland Limestone Cement", example=True)
+    finishable: bool | None = pyd.Field(default=None, description="Finishable", example=True)
+    fiber_reinforced: bool | None = pyd.Field(default=None, description="fiber_reinforced", example=True)
+
+    cementitious: Cementitious | None = pyd.Field(default=None, description="")
+
+    aggregate_size_max: LengthMmStr | None = pyd.Field(default=None, description="", example="0.0254 m")
+    cement_content: MassKgStr | None = pyd.Field(default=None, description="", example="1 kg")
+    aci_exposure_classes: list[AciExposureClass] | None = pyd.Field(default=None, description="", example=["aci.F0"])
+    csa_exposure_classes: list[CsaExposureClass] | None = pyd.Field(default=None, description="", example=["csa.C-2"])
+    en_exposure_classes: list[EnExposureClass] | None = pyd.Field(default=None, description="", example=["en206.X0"])
+    typical_application: ConcreteTypicalApplication | None = pyd.Field(default=None, description="Typical Application")
+
+    _concrete_compressive_strength_28d_is_quantity_validator = pyd.validator("strength_28d", allow_reuse=True)(
+        validate_unit_factory("MPa")
+    )
+    _concrete_compressive_strength_other_is_quantity_validator = pyd.validator("strength_other", allow_reuse=True)(
+        validate_unit_factory("MPa")
+    )
+    _concrete_slump_is_quantity_validator = pyd.validator("slump", allow_reuse=True)(validate_unit_factory("m"))
+    _concrete_min_slump_is_quantity_validator = pyd.validator("min_slump", allow_reuse=True)(validate_unit_factory("m"))
+    _concrete_max_slump_is_quantity_validator = pyd.validator("max_slump", allow_reuse=True)(validate_unit_factory("m"))
+    _concrete_min_pipeline_size_is_quantity_validator = pyd.validator("min_pipeline_size", allow_reuse=True)(
+        validate_unit_factory("m")
+    )
+    _concrete_aggregate_size_max_is_quantity_validator = pyd.validator("aggregate_size_max", allow_reuse=True)(
+        validate_unit_factory("m")
+    )
+    _concrete_cement_content_is_quantity_validator = pyd.validator("cement_content", allow_reuse=True)(
+        validate_unit_factory("kg")
+    )
+
+    # Nested specs:
+    CementGrout: CementGroutV1 | None = None
+    ConcretePaving: ConcretePavingV1 | None = None
+    FlowableFill: FlowableFillV1 | None = None
+    OilPatch: OilPatchV1 | None = None
+    ReadyMix: ReadyMixV1 | None = None
+    Shotcrete: ShotcreteV1 | None = None

openepd/model/specs/generated/conveying_equipment.py

@@ -0,0 +1,57 @@
+#
+#  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 ElevatorsBuildingRise, ElevatorsUsageIntensity
+from openepd.model.validation.quantity import LengthMStr, MassKgStr, validate_unit_factory
+
+
+class ElevatorsV1(BaseOpenEpdHierarchicalSpec):
+    """Elevators performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    # Own fields:
+    usage_intensity: list[ElevatorsUsageIntensity] | None = pyd.Field(
+        default=None, description="", example=["Very low"]
+    )
+    travel_length: LengthMStr | None = pyd.Field(default=None, description="", example="1 m")
+    rated_load: MassKgStr | None = pyd.Field(default=None, description="", example="1 kg")
+    rated_speed: str | None = pyd.Field(default=None, description="", example="1 m / s")
+    building_rise: ElevatorsBuildingRise | None = pyd.Field(default=None, description="", example="Low-rise")
+
+    _elevators_travel_length_is_quantity_validator = pyd.validator("travel_length", allow_reuse=True)(
+        validate_unit_factory("m")
+    )
+    _elevators_rated_load_is_quantity_validator = pyd.validator("rated_load", allow_reuse=True)(
+        validate_unit_factory("kg")
+    )
+    _elevators_rated_speed_is_quantity_validator = pyd.validator("rated_speed", allow_reuse=True)(
+        validate_unit_factory("m / s")
+    )
+
+
+class ConveyingEquipmentV1(BaseOpenEpdHierarchicalSpec):
+    """Conveying equipment performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    # Nested specs:
+    Elevators: ElevatorsV1 | None = None