openepd 3.1.0__tar.gz → 3.1.2__tar.gz

{openepd-3.1.0 → openepd-3.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openepd
-Version: 3.1.0
+Version: 3.1.2
 Summary: Python library to work with OpenEPD format
 Home-page: https://github.com/cchangelabs/openepd
 License: Apache-2.0
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Provides-Extra: api-client
 Requires-Dist: email-validator (>=1.3.1)
+Requires-Dist: idna (>=3.7)
 Requires-Dist: pydantic (>=1.10,<3.0)
 Requires-Dist: requests (>=2.0) ; extra == "api-client"
 Project-URL: Repository, https://github.com/cchangelabs/openepd

{openepd-3.1.0 → openepd-3.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openepd"
-version = "3.1.0"
+version = "3.1.2"
 license = "Apache-2.0"
 description = "Python library to work with OpenEPD format"
 authors = ["C-Change Labs <support@c-change-labs.com>"]
@@ -24,6 +24,7 @@ python = "^3.11"
 pydantic = ">=1.10,<3.0"
 email-validator = ">=1.3.1"
 requests = { version = ">=2.0", optional = true }
+idna = ">=3.7"
 
 # Optional dependencies
 # lxml = { version = "~=4.9.2", optional = true }
@@ -38,7 +39,7 @@ teamcity-messages = ">=1.31"
 wheel = "~=0.40.0"
 
 # Dev tools
-black = "~=22.3"
+black = "~=24.3"
 licenseheaders = "~=0.8"
 flake8 = "~=4.0"
 flake8-import-graph = "~=0.1.3"

{openepd-3.1.0 → openepd-3.1.2}/src/openepd/__version__.py

@@ -17,4 +17,4 @@
 #  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
 #  Find out more at www.BuildingTransparency.org
 #
-VERSION = "3.1.0"
+VERSION = "3.1.2"

{openepd-3.1.0 → openepd-3.1.2}/src/openepd/model/specs/concrete.py

@@ -159,16 +159,24 @@ class CmuSpec(BaseOpenEpdSpec):
 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")
+    opc: RatioFloat | None = pyd.Field(
+        default=None, description="Ordinary Gray Portland Cement", example=0.5, ge=0, le=1
+    )
+    wht: RatioFloat | None = pyd.Field(default=None, description="White Portland Cement", example=0.5, ge=0, le=1)
+    ggbs: RatioFloat | None = pyd.Field(
+        default=None, description="Ground Granulated Blast Furnace Slag", example=0.5, ge=0, le=1
+    )
+    flyAsh: RatioFloat | None = pyd.Field(
+        default=None, description="Fly Ash, including types F, CL, and CH", example=0.5, ge=0, le=1
+    )
+    siFume: RatioFloat | None = pyd.Field(default=None, description="Silica Fume", example=0.5, ge=0, le=1)
+    gg45: RatioFloat | None = pyd.Field(
+        default=None, description="Ground Glass, 45um or smaller", example=0.5, ge=0, le=1
+    )
+    natPoz: RatioFloat | None = pyd.Field(default=None, description="Natural pozzolan", example=0.5, ge=0, le=1)
+    mk: RatioFloat | None = pyd.Field(default=None, description="Metakaolin", example=0.5, ge=0, le=1)
+    CaCO3: RatioFloat | None = pyd.Field(default=None, description="Limestone", example=0.5, ge=0, le=1)
+    other: RatioFloat | None = pyd.Field(default=None, description="Other SCMs", example=0.5, ge=0, le=1)
 
 
 class TypicalApplication(BaseOpenEpdSchema):

{openepd-3.1.0 → openepd-3.1.2}/src/openepd/model/specs/generated/concrete.py

@@ -34,19 +34,26 @@ from openepd.model.validation.quantity import (
 
 
 class CementGroutV1(BaseOpenEpdHierarchicalSpec):
-    """Cement grout performance specification."""
+    """
+    Cement grout performance specification.
+
+    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 ConcretePavingV1(BaseOpenEpdHierarchicalSpec):
-    """Concrete paving performance specification."""
+    """Concrete paving."""
 
     _EXT_VERSION = "1.0"
 
     # Own fields:
     flexion_strength: PressureMPaStr | None = pyd.Field(
-        default=None, description="Paving flexion strength", example="30 MPa"
+        default=None, description="Concrete flexural strength.", example="30 MPa"
     )
 
     _concrete_flexion_strength_is_quantity_validator = pyd.validator("flexion_strength", allow_reuse=True)(
@@ -55,36 +62,58 @@ class ConcretePavingV1(BaseOpenEpdHierarchicalSpec):
 
 
 class FlowableFillV1(BaseOpenEpdHierarchicalSpec):
-    """Flowable fill performance specification."""
+    """
+    Flowable fill performance specification.
+
+    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):
-    """Oil patch performance specification."""
+    """
+    Petroleum Industry Cement Slurry.
+
+    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.
+    """
 
     _EXT_VERSION = "1.0"
 
 
 class ReadyMixV1(BaseOpenEpdHierarchicalSpec):
-    """Concretes that are mixed just before use, and then poured on-site into forms."""
+    """Concretes to be mixed and then poured on-site."""
 
     _EXT_VERSION = "1.0"
 
 
 class ShotcreteV1(BaseOpenEpdHierarchicalSpec):
-    """Shotcrete performance specification."""
+    """Concretes sprayed on a target."""
 
     _EXT_VERSION = "1.0"
 
 
 class ConcreteV1(BaseOpenEpdHierarchicalSpec):
-    """Concrete performance specification."""
+    """
+    Concrete.
+
+    A composite material composed of fine and coarse aggregate bonded together with a fluid cement (cement paste) that
+    hardens over time.
+    """
 
     _EXT_VERSION = "1.0"
 
     # Own fields:
-    lightweight: bool | None = pyd.Field(default=None, description="Lightweight", example=True)
+    lightweight: bool | None = pyd.Field(default=None, description="Product is lightweight", example=True)
 
     strength_28d: PressureMPaStr | None = pyd.Field(
         default=None, description="Concrete strength after 28 days", example="1 MPa"
@@ -95,14 +124,16 @@ class ConcreteV1(BaseOpenEpdHierarchicalSpec):
         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
+        default=None, description="Test Day for strength_other", 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")
+    min_pipeline_size: LengthMmStr | None = pyd.Field(
+        default=None, description="Minimum pipeline size", 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
     )
@@ -114,13 +145,27 @@ class ConcreteV1(BaseOpenEpdHierarchicalSpec):
     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="")
+    cementitious: Cementitious | None = pyd.Field(
+        default=None, description="List of cementitious materials, and proportion by mass"
+    )
 
-    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"])
+    aggregate_size_max: LengthMmStr | None = pyd.Field(
+        default=None,
+        description="The smallest sieve size for which the entire amount of aggregate is able to pass. "
+        "Parameter describes diameter of aggregate",
+        example="8 mm",
+    )
+    cement_content: MassKgStr | None = pyd.Field(default=None, example="1 kg")
+
+    aci_exposure_classes: list[AciExposureClass] | None = pyd.Field(
+        default=None, description="List of ACI exposure classes", example=["aci.F0"]
+    )
+    csa_exposure_classes: list[CsaExposureClass] | None = pyd.Field(
+        default=None, description="List of CSA exposure classes", example=["csa.C-2"]
+    )
+    en_exposure_classes: list[EnExposureClass] | None = pyd.Field(
+        default=None, description="List of EN exposure classes", 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)(

{openepd-3.1.0 → openepd-3.1.2}/src/openepd/model/specs/generated/enums.py

@@ -372,14 +372,14 @@ class FrameMaterial(StrEnum):
     """
     Frame material.
 
-     - Vinyl: Vinyl
-     - Aluminium: Aluminium
-     - Steel: Steel
-     - Wood: Wood
-     - Fiberglass: Fiberglass
-     - Composite: Composite
-     - None: None
-     - Other: Other
+     - Vinyl: PVC and similar polymer frames
+     - Aluminium: Aluminium, with optional thermal improvement. Does not include aluminium clad.
+     - Steel: Steel, with optional thermal improvement
+     - Wood: Wood with optional cladding
+     - Fiberglass: Fiber reinforced plastic
+     - Composite: Plastic and Wood Fiber composite.
+     - None: This EPD does not cover the frame.
+     - Other: Other framing material not listed
 
     """
 
@@ -1793,12 +1793,12 @@ class HardwareFunction(StrEnum):
     """
     Hardware function.
 
-     - Lock: Lock
-     - Hinge: Hinge
-     - Handle: Handle
-     - Operator: Operator
-     - Balance: Balance
-     - Other: Other
+     - Lock: Locks, Keepers, and similar items that resist opening.
+     - Hinge: Hinges, Pivots, and similar items that secure glazing to the frame while it moves.
+     - Handle: Handles, knobs, and similar items for directly manipulating a window.
+     - Operator: Arms, Cranks, and other hardware that moves a window.
+     - Balance: Springs, Sash Balances, and other items that counter the weight of an operable sash.
+     - Other: Other hardware not described above.
 
     """
 
@@ -1975,11 +1975,17 @@ class ThermalSeparation(StrEnum):
     """
     Thermal separation.
 
-     - Aluminium: Aluminium
-     - Steel: Steel
-     - Thermally Improved Metal: Thermally Improved Metal
-     - Thermally Broken Metal: Thermally Broken Metal
-     - Nonmetal: Nonmetal
+     - Aluminium: Aluminium System members with less than 1.6 mm (0.062 in) or no separation between metal or system
+       members to provide a resistance heat transfer path from exterior to interior.
+     - Steel: Steel System members with less than 1.6 mm (0.062 in) or no separation between metal or system members to
+       provide a resistance heat transfer path from exterior to interior.
+     - Thermally Improved Metal: Metal System members with a separation ≥ 1.60 mm (0.062 in) provided by either a
+       thermal break or open air space that may be interrupted by short thermal bridges between the interior and
+       exterior surfaces.
+     - Thermally Broken Metal: Aluminium System members with a minimum of 5.30 mm (0.210 in) separation provided by
+       a thermal break.
+     - Nonmetal: Nonmetal material where the path from inside to outside inherently has low thermal conductivity,
+       such as wood, vinyl, and fiberglass. Aluminium-clad or split windows fall in this category.
 
     """
 
@@ -2376,7 +2382,7 @@ class FlatGlassPanesThickness(StrEnum):
 
 
 class NAFSPerformanceGrade(StrEnum):
-    """NAFS Performance Grade enum."""
+    """NAFS Performance Grade."""
 
     GRADE_15_PSF = "15 psf"
     GRADE_20_PSF = "20 psf"