openepd 5.0.0__py3-none-any.whl → 5.1.1__py3-none-any.whl

openepd/model/specs/range/utility_piping.py

@@ -0,0 +1,75 @@
+#
+#  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.
+#
+__all__ = (
+    "BuildingHeatingPipingRangeV1",
+    "BuriedPipingRangeV1",
+    "UtilityPipingRangeV1",
+)
+
+# NB! This is a generated code. Do not edit it manually. Please see src/openepd/model/specs/README.md
+
+
+from openepd.compat.pydantic import pyd
+from openepd.model.common import RangeAmount
+from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
+from openepd.model.specs.generated.enums import BuriedPipingType, PipingAnsiSchedule, UtilityPipingMaterial
+from openepd.model.validation.quantity import AmountRangeLengthMm
+
+
+class BuildingHeatingPipingRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Heating piping.
+
+    System of pipes used to supply heated fluids (liquids or steam) for purposes of controlling temperature inside a
+    home, business, or other building facility.
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+
+class BuriedPipingRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    System of pipes used to provide or transport fluids (liquids and gases) underground.
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+    buried_piping_type: list[BuriedPipingType] | None = pyd.Field(default=None, description="")
+
+
+class UtilityPipingRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Utility piping.
+
+    System of pipes used to convey fluids (liquids and gases) from one location to another. Piping can be metal,
+    plastic, concrete, fiberglass, or other materials.
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+    thickness: AmountRangeLengthMm | None = pyd.Field(default=None, description="")
+    piping_diameter: AmountRangeLengthMm | None = pyd.Field(default=None, description="")
+    mass_per_unit_length: RangeAmount | None = pyd.Field(default=None, description="")
+    piping_ansi_schedule: list[PipingAnsiSchedule] | None = pyd.Field(default=None, description="")
+    utility_piping_material: list[UtilityPipingMaterial] | None = pyd.Field(default=None, description="")
+    BuildingHeatingPiping: BuildingHeatingPipingRangeV1 | None = None
+    BuriedPiping: BuriedPipingRangeV1 | None = None

openepd/model/specs/range/wood.py

@@ -0,0 +1,228 @@
+#
+#  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.
+#
+__all__ = (
+    "WoodDeckingRangeV1",
+    "WoodFramingRangeV1",
+    "PrefabricatedWoodInsulatedPanelsRangeV1",
+    "PrefabricatedWoodTrussRangeV1",
+    "CompositeLumberRangeV1",
+    "DimensionLumberRangeV1",
+    "HeavyTimberRangeV1",
+    "MassTimberRangeV1",
+    "NonStructuralWoodRangeV1",
+    "PrefabricatedWoodRangeV1",
+    "SheathingPanelsRangeV1",
+    "UnfinishedWoodRangeV1",
+    "WoodRangeV1",
+)
+
+# NB! This is a generated code. Do not edit it manually. Please see src/openepd/model/specs/README.md
+
+
+from openepd.compat.pydantic import pyd
+from openepd.model.common import RangeFloat, RangeRatioFloat
+from openepd.model.org import OrgRef
+from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
+from openepd.model.specs.generated.enums import (
+    AllFabrication,
+    AllTimberSpecies,
+    CompositeLumberFabrication,
+    EngineeredTimberSpecies,
+    MassTimberFabrication,
+    SawnTimberSpecies,
+    SheathingPanelsFabrication,
+)
+from openepd.model.validation.quantity import AmountRangeLengthMm
+
+
+class WoodDeckingRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Dimensional boards for exterior decking.
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+
+class WoodFramingRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Dimension lumber for light framing.
+
+    Includes solid and finger-jointed lumber. Standard shapes include 2x4, 2x6, and 2x8.
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+
+class PrefabricatedWoodInsulatedPanelsRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Structural insulated panels (SIPs).
+
+    Consist of wood sheet layer(s) combined with (typically foam) insulation layer(s).
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+
+class PrefabricatedWoodTrussRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Shop-fabricated wood truss.
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+
+class CompositeLumberRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Shop-fabricated structural Lumber.
+
+    Includes Laminated Strand Lumber (LSL), Parallel Strand Lumber (PSL), and Laminated Veneer Lumber (LVL).
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+    fabrication: list[CompositeLumberFabrication] | None = pyd.Field(default=None, description="")
+    timber_species: list[EngineeredTimberSpecies] | None = pyd.Field(default=None, description="")
+
+
+class DimensionLumberRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Dimension lumber for framing, decking, and other purposes.
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+    timber_species: list[SawnTimberSpecies] | None = pyd.Field(default=None, description="")
+    WoodDecking: WoodDeckingRangeV1 | None = None
+    WoodFraming: WoodFramingRangeV1 | None = None
+
+
+class HeavyTimberRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Large format, unfinished natural timber.
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+
+class MassTimberRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Engineered heavy timber products.
+
+    Includes glue laminated (glulam), cross-laminated timber (CLT), dowel laminated timber (DLT), and nail laminated
+    timber (NLT).
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+    fabrication: list[MassTimberFabrication] | None = pyd.Field(default=None, description="")
+    timber_species: list[EngineeredTimberSpecies] | None = pyd.Field(default=None, description="")
+
+
+class NonStructuralWoodRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Non-structural interior and exterior wood products for trim, cabinets, countertops, etc.
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+
+class PrefabricatedWoodRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Prefabricated wood structural members made primarily from one or more types of wood.
+
+    Includes products made with metallic connectors, insulation, etc. Excludes products where the wood is merely
+    decorative.
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+    PrefabricatedWoodInsulatedPanels: PrefabricatedWoodInsulatedPanelsRangeV1 | None = None
+    PrefabricatedWoodTruss: PrefabricatedWoodTrussRangeV1 | None = None
+
+
+class SheathingPanelsRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Wood sheets used for structural sheathing, including plywood and Oriented Strand Board.
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+    fabrication: list[SheathingPanelsFabrication] | None = pyd.Field(default=None, description="")
+    wood_board_thickness: AmountRangeLengthMm | None = pyd.Field(default=None, description="")
+    timber_species: list[EngineeredTimberSpecies] | None = pyd.Field(default=None, description="")
+
+
+class UnfinishedWoodRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Raw logs and other unfinished wood products.
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+
+class WoodRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Structural Wood Products used in construction.
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+    forest_practices_certifiers: list[OrgRef] | None = None
+    timber_species: list[AllTimberSpecies] | None = pyd.Field(default=None, description="Timber species")
+    fabrication: list[AllFabrication] | None = pyd.Field(default=None, description="Timber fabrication")
+    weather_exposed: bool | None = pyd.Field(default=None, description="Weather exposed")
+    fire_retardant: bool | None = pyd.Field(default=None, description="Fire retardant")
+    decay_resistant: bool | None = pyd.Field(default=None, description="Decay resistant")
+    fsc_certified: RangeRatioFloat | None = pyd.Field(
+        default=None, description="Forest Stewardship Council certified proportion"
+    )
+    fsc_certified_z: RangeFloat | None = pyd.Field(default=None, description="")
+    recycled_content: RangeRatioFloat | None = pyd.Field(default=None, description="Recycled content")
+    recycled_content_z: RangeFloat | None = pyd.Field(default=None, description="")
+    CompositeLumber: CompositeLumberRangeV1 | None = None
+    DimensionLumber: DimensionLumberRangeV1 | None = None
+    HeavyTimber: HeavyTimberRangeV1 | None = None
+    MassTimber: MassTimberRangeV1 | None = None
+    NonStructuralWood: NonStructuralWoodRangeV1 | None = None
+    PrefabricatedWood: PrefabricatedWoodRangeV1 | None = None
+    SheathingPanels: SheathingPanelsRangeV1 | None = None
+    UnfinishedWood: UnfinishedWoodRangeV1 | None = None

openepd/model/specs/range/wood_joists.py

@@ -0,0 +1,44 @@
+#
+#  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.
+#
+__all__ = ("WoodJoistsRangeV1",)
+
+# NB! This is a generated code. Do not edit it manually. Please see src/openepd/model/specs/README.md
+
+
+from openepd.compat.pydantic import pyd
+from openepd.model.org import OrgRef
+from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
+from openepd.model.specs.generated.enums import AllFabrication, AllTimberSpecies
+
+
+class WoodJoistsRangeV1(BaseOpenEpdHierarchicalSpec):
+    """
+    Wood joists.
+
+    Prefabricated I-shaped engineered wood structural members made primarily from one or more types of wood. Includes
+    products made with metallic webbing. Excludes products where the wood is merely decorative.
+
+    Range version.
+    """
+
+    _EXT_VERSION = "1.0"
+
+    forest_practices_certifiers: list[OrgRef] | None = None
+    timber_species: list[AllTimberSpecies] | None = pyd.Field(default=None, description="")
+    fabrication: list[AllFabrication] | None = pyd.Field(default=None, description="")
+    weather_exposed: bool | None = pyd.Field(default=None, description="")
+    fire_retardant: bool | None = pyd.Field(default=None, description="")
+    decay_resistant: bool | None = pyd.Field(default=None, description="")

openepd/model/validation/numbers.py

@@ -13,10 +13,16 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-from typing import Annotated
 
-from openepd.compat.pydantic import pyd
 
-# todo when move to pydantic 2, check that validators are being enforced.
-RatioFloat = Annotated[float, pyd.Field(ge=0, le=1, example=0.5)]
-PositiveInt = Annotated[int, pyd.Field(ge=0, example=1)]
+# todo when move to pydantic 2, these should change to Annotated[float, ...]
+class RatioFloat(float):
+    """Float representing a ratio (0-1)."""
+
+    pass
+
+
+class PositiveInt(int):
+    """Greater than zero integer."""
+
+    pass