openepd 1.7.1__py3-none-any.whl → 1.8.0__py3-none-any.whl

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 = "1.7.1"
+VERSION = "1.8.0"

openepd/api/dto/common.py

@@ -111,4 +111,7 @@ class OpenEpdApiResponse(GenericModel, BaseOpenEpdApiModel, Generic[TPayload, TM
     """Standard DTO representing response from OpenEPD API server."""
 
     payload: TPayload
-    meta: TMeta
+    # there is an issue with using covariant type variables as parameters when used for container mutable types,
+    # as described in https://github.com/python/mypy/issues/7049
+    # However, in our workflow TMeta is not a container type which is further returned back to caller.
+    meta: TMeta  # type: ignore[misc]

openepd/api/epd/dto.py

@@ -37,20 +37,34 @@ class StatisticsDto(BaseOpenEpdApiModel):
     """
 
     # percentiles
-    pct10_gwp: float = pyd.Field("10th percentile GWP for this statistics measured in kgCO2e per declared unit")
+    pct10_gwp: float = pyd.Field(
+        description="10th percentile GWP for this statistics measured in kgCO2e per declared unit"
+    )
     achievable_target: float = pyd.Field(
         description="Achievable target. 20th percentile of GWP measured in kgCO2e per declared unit", example=445.65
     )
-    pct30_gwp: float = pyd.Field("30th percentile GWP for this statistics measured in kgCO2e per declared unit")
-    pct40_gwp: float = pyd.Field("40th percentile GWP for this statistics measured in kgCO2e per declared unit")
-    pct50_gwp: float = pyd.Field("50th percentile GWP for this statistics measured in kgCO2e per declared unit")
-    pct60_gwp: float = pyd.Field("60th percentile GWP for this statistics measured in kgCO2e per declared unit")
-    pct70_gwp: float = pyd.Field("70th percentile GWP for this statistics measured in kgCO2e per declared unit")
+    pct30_gwp: float = pyd.Field(
+        description="30th percentile GWP for this statistics measured in kgCO2e per declared unit"
+    )
+    pct40_gwp: float = pyd.Field(
+        description="40th percentile GWP for this statistics measured in kgCO2e per declared unit"
+    )
+    pct50_gwp: float = pyd.Field(
+        description="50th percentile GWP for this statistics measured in kgCO2e per declared unit"
+    )
+    pct60_gwp: float = pyd.Field(
+        description="60th percentile GWP for this statistics measured in kgCO2e per declared unit"
+    )
+    pct70_gwp: float = pyd.Field(
+        description="70th percentile GWP for this statistics measured in kgCO2e per declared unit"
+    )
     conservative_estimate: float = pyd.Field(
         description="Conservative estimate. 80th percentile of GWP per declared unit measured in kgCO2e",
         example=640.778,
     )
-    pct90_gwp: float = pyd.Field("70th percentile GWP for this statistics measured in kgCO2e per declared unit")
+    pct90_gwp: float = pyd.Field(
+        description="70th percentile GWP for this statistics measured in kgCO2e per declared unit"
+    )
 
     # stats
     average: float = pyd.Field(description="Average GWP in kgCO2e per declared unit", example=554.2)

openepd/api/pcr/dto.py

@@ -25,15 +25,14 @@ from openepd.api.dto.base import BaseOpenEpdApiModel
 class PcrRef(BaseOpenEpdApiModel):
     """Reference to a PCR."""
 
-    id: str = pyd.Field(
+    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,
     )
-    name: str = pyd.Field(
+    name: str | None = pyd.Field(
         max_length=200,
-        default=None,
         description="Full document name as listed in source document",
         example="c-PCR-003 Concrete and concrete elements (EN 16757)",
     )

openepd/model/epd.py

@@ -55,7 +55,7 @@ class EpdV0(WithAttachmentsMixin, WithAltIdsMixin, BaseEpd):
         default=None,
     )
     product_name: str | None = pyd.Field(
-        max_length=200, description="The name of the product described by this EPD", example="Mix 12345AC"
+        max_length=200, description="The name of the product described by this EPD", example="Mix 12345AC", default=None
     )
     product_sku: str | None = pyd.Field(
         max_length=200, description="Unique stock keeping identifier assigned by manufacturer"

openepd/model/org.py

@@ -29,8 +29,8 @@ from openepd.model.validation.common import ReferenceStr
 class OrgRef(BaseOpenEpdSchema):
     """Represents Organisation with minimal data."""
 
-    web_domain: str = pyd.Field(
-        description="A web domain owned by organization. Typically is the org's home website address"
+    web_domain: str | None = pyd.Field(
+        description="A web domain owned by organization. Typically is the org's home website address", default=None
     )
     name: str | None = pyd.Field(
         max_length=200,

openepd/model/specs/concrete.py

@@ -43,6 +43,13 @@ class AciExposureClass(StrEnum):
       * `aci.S1` - Exposed to <1500 ppm of SO4 in water and <0.2% SO4 in soil
       * `aci.S2` - Exposed to <10000 ppm of SO4 in water and <2% SO4 in soil
       * `aci.S3` - Exposed to >10000 ppm of SO4 in water or >2% SO4 in soil
+
+      * `aci.C1` - Concrete in contact with moisture, but the external source of chloride does not reach it.
+      * `aci.C2` - Concrete subjected to moisture and an external source of chlorides such as deicing chemicals,
+                    salt, brackish water, seawater, or spray from these sources.
+      * `aci.W0` - Concrete dry in service
+      * `aci.W1` - Concrete in contact with water, no requirement for low permeability
+      * `aci.W2` - Concrete in contact with water where low permeability is required
     """
 
     F0 = "aci.F0"
@@ -53,6 +60,11 @@ class AciExposureClass(StrEnum):
     S1 = "aci.S1"
     S2 = "aci.S2"
     S3 = "aci.S3"
+    C1 = "aci.C1"
+    C2 = "aci.C2"
+    W0 = "aci.W0"
+    W1 = "aci.W1"
+    W2 = "aci.W2"
 
 
 class CsaExposureClass(StrEnum):
@@ -357,39 +369,69 @@ class ConcreteV1Options(BaseOpenEpdSchema):
     fiber_reinforced: bool | None = pyd.Field(description="Fiber reinforced", default=None)
 
 
-class ConcreteV1Mixin(BaseOpenEpdHierarchicalSpec):
-    """Concrete common properties mixin."""
+class ReadyMixV1(BaseOpenEpdHierarchicalSpec):
+    """Concretes to be mixed and then poured on-site."""
 
-    strength_28d: PressureMPaStr | None = pyd.Field(
-        default=None, example="30 MPa", description="Concrete strength after 28 days"
-    )
-    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=None
-    )
-    csa_exposure_classes: list[CsaExposureClass] = pyd.Field(
-        description=(CsaExposureClass.__doc__ or "").lstrip(), default=None
-    )
-    en_exposure_classes: list[EnExposureClass] = pyd.Field(
-        description=(EnExposureClass.__doc__ or "").lstrip(), default=None
-    )
-    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 = pyd.Field(description="Concrete options", default=None)
+    pass
 
-    _compressive_strength_unit_validator = pyd.validator("strength_28d", allow_reuse=True, check_fields=False)(
-        validate_unit_factory(OpenEPDUnit.MPa)
-    )
+
+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.
+    """
+
+    pass
+
+
+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.
+    """
+
+    pass
+
+
+class ConcretePavingV1(BaseOpenEpdHierarchicalSpec):
+    """Concrete paving."""
+
+    pass
 
 
-class ConcreteV1(ConcreteV1Mixin, BaseOpenEpdHierarchicalSpec):
+class ShotcreteV1(BaseOpenEpdHierarchicalSpec):
+    """Concretes sprayed on a target."""
+
+    pass
+
+
+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.
+
+    """
+
+
+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",
@@ -405,7 +447,34 @@ class ConcreteV1(ConcreteV1Mixin, BaseOpenEpdHierarchicalSpec):
         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)
     )
@@ -424,10 +493,26 @@ class ConcreteV1(ConcreteV1Mixin, BaseOpenEpdHierarchicalSpec):
         return values
 
 
-class PrecastConcreteV1(ConcreteV1Mixin, BaseOpenEpdHierarchicalSpec):
+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/versioning.py

@@ -37,7 +37,8 @@ class WithExtVersionMixin(ABC, BaseModel):
         if hasattr(cls, "_EXT_VERSION"):
             cls.__fields__["ext_version"].default = cls._EXT_VERSION
 
-    ext_version: str = pyd.Field(description="Extension version", example="3.22", default=None)
+    # Note: default is set programmatically in __init_subclass__
+    ext_version: str | None = pyd.Field(description="Extension version", example="3.22", default=None)
 
 
 class Version(NamedTuple):

{openepd-1.7.1.dist-info → openepd-1.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openepd
-Version: 1.7.1
+Version: 1.8.0
 Summary: Python library to work with OpenEPD format
 Home-page: https://github.com/cchangelabs/openepd
 License: Apache-2.0

{openepd-1.7.1.dist-info → openepd-1.8.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 openepd/__init__.py,sha256=rqQJWF5jpYAgRbbAycUfWMGsr5kGtfjmwzsTeqbElJw,837
-openepd/__version__.py,sha256=Ez8Wg4K4dGA7L-OxPGJKL44MCHbULZpwqVUAy9hz7n0,855
+openepd/__version__.py,sha256=6YlL51CiEXjMXGC4aYqdXMGp923puMgij54LxJ2lhek,855
 openepd/api/__init__.py,sha256=rqQJWF5jpYAgRbbAycUfWMGsr5kGtfjmwzsTeqbElJw,837
 openepd/api/base_sync_client.py,sha256=JcNpWsGoIK_1Eg27CAQd7nIjbcfD56jQ1nS6B48Q0cI,21142
 openepd/api/category/__init__.py,sha256=rqQJWF5jpYAgRbbAycUfWMGsr5kGtfjmwzsTeqbElJw,837
@@ -8,16 +8,16 @@ openepd/api/category/sync_api.py,sha256=QLEyga590UON9zv7864NjdSPkxSoeWObIOCUOLhD
 openepd/api/common.py,sha256=rfxjaDd7gGoen85wSooHt0W9xHdUlSlkTlkr2CO1ccg,8681
 openepd/api/dto/__init__.py,sha256=rqQJWF5jpYAgRbbAycUfWMGsr5kGtfjmwzsTeqbElJw,837
 openepd/api/dto/base.py,sha256=r3vxG3CpSS2M_L6k5mHVA4_Khunxkmh4QxEPjLOwft8,1233
-openepd/api/dto/common.py,sha256=eiOmV-pk4uVdbqPxIzlS5cB60EnthT3GyFSmprc4-_c,4389
+openepd/api/dto/common.py,sha256=u6N-MmKoS1SZ7-IdVLHU8PQYGxPKKV8-NcZassIaKzo,4692
 openepd/api/dto/meta.py,sha256=_jrQuzmWhhitdB0_tREGLdzU2iGOZqYy84zsC3Hexhw,2361
 openepd/api/dto/mf.py,sha256=4jqhXqSGtA_MRXvJJFXtj4xMhsT9rucveyVAxt8V-oc,2195
 openepd/api/dto/params.py,sha256=rqQJWF5jpYAgRbbAycUfWMGsr5kGtfjmwzsTeqbElJw,837
 openepd/api/epd/__init__.py,sha256=rqQJWF5jpYAgRbbAycUfWMGsr5kGtfjmwzsTeqbElJw,837
-openepd/api/epd/dto.py,sha256=q_fJxPn-LD13bQtzw0kT691iesaEi3ffn7P080bDPa4,4893
+openepd/api/epd/dto.py,sha256=-uEQRi2DBUIrtulgZ8D_qNbptBNrA-vJA09JeeY114Q,5075
 openepd/api/epd/sync_api.py,sha256=JEZR3WBZHqP4yOk1qkWsz0oKHMgegoZ7Pvoh6YTVefg,4391
 openepd/api/errors.py,sha256=K6L_T91iJLFSl_7hVS6poV_BUjZJe3qJBUzp8mItm7g,2376
 openepd/api/pcr/__init__.py,sha256=rqQJWF5jpYAgRbbAycUfWMGsr5kGtfjmwzsTeqbElJw,837
-openepd/api/pcr/dto.py,sha256=_TXNsKMcn0JaTb6GfDIcR-TPJEPwslrk1N6cPDkm6NU,1641
+openepd/api/pcr/dto.py,sha256=CljjYK50Xz7wlIc0TfpTyyQLwdMao3SJW3hSHJpd8i4,1633
 openepd/api/pcr/sync_api.py,sha256=j8g23-FuaN2JkROVRo32v77JWpTWDIOWnIyomBbqNd4,1805
 openepd/api/sync_client.py,sha256=DBkoB8rH8OG1d1sJ77h2YvIP8aFQX5eCfaX4sTN0vEs,2504
 openepd/api/test/__init__.py,sha256=rqQJWF5jpYAgRbbAycUfWMGsr5kGtfjmwzsTeqbElJw,837
@@ -30,17 +30,17 @@ openepd/model/__init__.py,sha256=rqQJWF5jpYAgRbbAycUfWMGsr5kGtfjmwzsTeqbElJw,837
 openepd/model/base.py,sha256=R81hZd8EZBM2E9EhQbzNa9JLRzAjeNPPkZYEmoUM4v0,9132
 openepd/model/category.py,sha256=_6yFyldaDrkZk2_9ZAO2oRTz7ocvkg4T-D_aw5ncgvo,1840
 openepd/model/common.py,sha256=j-M_2T_Kl_Ea8l50pJT7LNatBW1fKrRcw4XNpeNvLU0,5635
-openepd/model/epd.py,sha256=BxcKJd_LuApB2v_LGN0-hYLNaUNoqMu9ZH_V1Ffil-g,14269
+openepd/model/epd.py,sha256=T935Aaz6jULmFQHasqfwzgfvHKJ6tSSkbWKWUQ_XPk0,14283
 openepd/model/factory.py,sha256=qQZNb4yFN1EQWHHVS-fHnJ2gB-vsKz9hVmXXJE7YaRU,1918
 openepd/model/lcia.py,sha256=4AffuUYDZISwhJFcUC_r3JJYq4zL_q0RwS6KatYotU0,17149
-openepd/model/org.py,sha256=5Iciua-cKlicVzoo8y1wJjFOM1P8TGZDRhkB0Eu2kgw,3976
+openepd/model/org.py,sha256=xV3MQE6iMaXtQWHHwGnjlE5LAd0Joyt-JuvOIvOLQ_4,3997
 openepd/model/pcr.py,sha256=t861yFntmy3ewrnGLP47cv3afV-aCCVRlrbpGeRh-7I,4604
 openepd/model/specs/README.md,sha256=W5LSMpZuW5x36cKS4HRfeFsClsRf8J9yHMMICghdc0s,862
 openepd/model/specs/__init__.py,sha256=nNs2nu1DIKyFC2A-Wc6Zk2VguSti3bC0gMpjop692z0,2299
 openepd/model/specs/aluminium.py,sha256=UqTX1gigGNgR9jWi4TEM-bKVGlZ_MBkdsLx4H1-H7KA,2246
 openepd/model/specs/asphalt.py,sha256=lBHTultMZqWXe9u-inGzcZRBkvW6axFZ10REZv-OBys,3533
 openepd/model/specs/base.py,sha256=S2KmHpBjjZnJ67FS3VJBA3aQ0a440OmhFFTqM8ZEOMM,2681
-openepd/model/specs/concrete.py,sha256=Nhe-6o6saaNQQc1E3013u4C7XmZGYg06-HLuHFS_IGU,19920
+openepd/model/specs/concrete.py,sha256=Hu6PxoyfRAeDGInMfHayOc8FZc8w5FS3tUCKxdBpOxM,23097
 openepd/model/specs/glass.py,sha256=Zn8cKTGxhoQujtv4F7HtfMkZugV5DMt_HQ6dw0sUugs,14865
 openepd/model/specs/steel.py,sha256=n9hnOwJ8ZixVdd9M-R_wHego35qWinGe8W184EwHASo,6334
 openepd/model/specs/wood.py,sha256=ehKJqqW9VfNKgM1S3gazfNNL4Af4SKZBm7HttAjokZQ,5128
@@ -49,9 +49,9 @@ openepd/model/validation/__init__.py,sha256=rqQJWF5jpYAgRbbAycUfWMGsr5kGtfjmwzsT
 openepd/model/validation/common.py,sha256=afJrWSvxMf8s9Y80-bG67Fp6W5siqtciMJ3Z6nUOPAI,2636
 openepd/model/validation/numbers.py,sha256=60Z9hT8nQwJHvUL7k5nBZsHxxWhaIxNKVbW3BnHS8zM,1088
 openepd/model/validation/quantity.py,sha256=-JGwdeSWuBSgtUizoSOg-6t3NFaGuumn5Ngd01rYxPs,2873
-openepd/model/versioning.py,sha256=Z31TgCW0POsmXLrH-Rmpy-MrIw_bU_9wwh8T4Mq1yTM,4628
+openepd/model/versioning.py,sha256=fpj45RmphEI5u9fKZLI8FWa83cjH-wkeIU1RLLLwmX8,4700
 openepd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openepd-1.7.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-1.7.1.dist-info/METADATA,sha256=upVZIJSePASSpJpdz5r0rKApe3vca7KW8qgLErVqwWw,7762
-openepd-1.7.1.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-openepd-1.7.1.dist-info/RECORD,,
+openepd-1.8.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openepd-1.8.0.dist-info/METADATA,sha256=r3C2sR1Zz5kmEkaZQbnYg6LKvXK3HFidysHpUOPepcU,7762
+openepd-1.8.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+openepd-1.8.0.dist-info/RECORD,,