openepd 4.6.0__py3-none-any.whl → 4.7.0__py3-none-any.whl

openepd/__version__.py

@@ -13,4 +13,4 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-VERSION = "4.6.0"
+VERSION = "4.7.0"

openepd/model/base.py

@@ -16,7 +16,7 @@
 import abc
 from enum import StrEnum
 import json
-from typing import Any, Callable, Generic, Optional, Type, TypeAlias, TypeVar
+from typing import Any, Callable, ClassVar, Generic, Optional, Type, TypeAlias, TypeVar
 
 from openepd.compat.pydantic import pyd, pyd_generics
 from openepd.model.validation.common import validate_version_compatibility, validate_version_format
@@ -177,7 +177,7 @@ TOpenEpdObjectClass = TypeVar("TOpenEpdObjectClass", bound=Type[BaseOpenEpdSchem
 class RootDocument(abc.ABC, BaseOpenEpdSchema):
     """Base class for all objects representing openEPD root element. E.g. Epd, IndustryEpd, GenericEstimate, etc."""
 
-    _FORMAT_VERSION: str
+    _FORMAT_VERSION: ClassVar[str]
     """Version of this document format. Must be defined in the concrete class."""
 
     doctype: str = pyd.Field(

openepd/model/epd.py

@@ -20,7 +20,7 @@ from openepd.model.base import BaseDocumentFactory, OpenEpdDoctypes
 from openepd.model.common import Amount, Ingredient, WithAltIdsMixin, WithAttachmentsMixin
 from openepd.model.declaration import BaseDeclaration
 from openepd.model.lcia import WithLciaMixin
-from openepd.model.org import Org, OrgRef, Plant
+from openepd.model.org import Org, Plant
 from openepd.model.specs import Specs
 from openepd.model.versioning import OpenEpdVersions, Version
 
@@ -66,8 +66,8 @@ class EpdPreviewV0(WithAttachmentsMixin, WithAltIdsMixin, BaseDeclaration, title
         description="Link to data object on original registrar's site",
         example="https://epd-online.com/EmbeddedEpdList/Download/6029",
     )
-    manufacturer: OrgRef | None = pyd.Field(description=MANUFACTURER_DESCRIPTION)
-    epd_developer: OrgRef | None = pyd.Field(
+    manufacturer: Org | None = pyd.Field(description=MANUFACTURER_DESCRIPTION)
+    epd_developer: Org | None = pyd.Field(
         description=DEVELOPER_DESCRIPTION,
         default=None,
     )
@@ -82,14 +82,14 @@ class EpdPreviewV0(WithAttachmentsMixin, WithAltIdsMixin, BaseDeclaration, title
         description="List of object(s) for one or more plant(s) that this declaration applies to.",
         default_factory=list,
     )
-    program_operator: OrgRef | None = pyd.Field(description=PROGRAM_OPERATOR_DESCRIPTION)
+    program_operator: Org | None = pyd.Field(description=PROGRAM_OPERATOR_DESCRIPTION)
     program_operator_doc_id: str | None = pyd.Field(
         max_length=200, description="Document identifier from Program Operator.", example="123-456.789/b"
     )
     program_operator_version: str | None = pyd.Field(
         max_length=200, description="Document version number from Program Operator.", example="4.3.0"
     )
-    third_party_verifier: OrgRef | None = pyd.Field(description=THIRD_PARTY_VERIFIER_DESCRIPTION)
+    third_party_verifier: Org | None = pyd.Field(description=THIRD_PARTY_VERIFIER_DESCRIPTION)
     third_party_verification_url: pyd.AnyUrl | None = pyd.Field(
         description="Optional link to a verification statement.",
         example="https://we-verify-epds.com/en/letters/123-456.789b.pdf",
@@ -204,6 +204,8 @@ class EpdWithDepsV0(EpdV0, title="EPD (with Dependencies)"):
     Expanded version of the EPD.
 
     Contains related entities - orgs - with full fields, to support object matching in implementations.
+    For now the implementation matches the above EpdV0 entity, but they will diverge as normal Epd would have
+    some required fields in Org (like web_domain), and WithDeps would not.
     """
 
     manufacturer: Org | None = pyd.Field(description=MANUFACTURER_DESCRIPTION)

openepd/model/generic_estimate.py

@@ -21,7 +21,7 @@ from openepd.model.common import WithAltIdsMixin, WithAttachmentsMixin
 from openepd.model.declaration import BaseDeclaration
 from openepd.model.geography import Geography
 from openepd.model.lcia import WithLciaMixin
-from openepd.model.org import Org, OrgRef
+from openepd.model.org import Org
 from openepd.model.versioning import OpenEpdVersions, Version
 
 
@@ -65,11 +65,11 @@ class GenericEstimatePreviewV0(WithAttachmentsMixin, BaseDeclaration, title="Gen
         description="1-paragraph description of the Generic Estimate. Supports plain text or github flavored markdown.",
     )
 
-    publisher: OrgRef | None = pyd.Field(description="Organization that published the LCA results.")
+    publisher: Org | None = pyd.Field(description="Organization that published the LCA results.")
     reviewer_email: pyd.EmailStr | None = pyd.Field(
         description="Email address of the third party verifier", example="john.doe@example.com", default=None
     )
-    reviewer: OrgRef | None = pyd.Field(description="Org that performed a critical review of the LCA.")
+    reviewer: Org | None = pyd.Field(description="Org that performed a critical review of the LCA.")
     license_terms: LicenseTerms | None = pyd.Field(description="The license terms for use of the data.")
     geography: list[Geography] | None = pyd.Field(
         "Jurisdiction(s) in which the LCA result is applicable.  An empty array, or absent properties, implies global applicability."
@@ -102,6 +102,10 @@ class GenericEstimateWithDepsV0(GenericEstimateV0, title="Generic Estimate (with
     Expanded version of the GenericEstimate.
 
     Contains related entities - orgs - with full fields, to support object matching in implementations.
+
+    For now the implementation matches the above GenericEstimate entity, but they will diverge as normal GE would have
+    some required fields in Org (like web_domain), and WithDeps would not.
+
     """
 
     publisher: Org | None = pyd.Field(description="Organization that published the LCA results.")

openepd/model/specs/generated/enums.py

@@ -982,6 +982,65 @@ class HvacHeatExchangersType(StrEnum):
     SPIRAL = "Spiral"
 
 
+class HvacDuctType(StrEnum):
+    """
+    Hvac duct type.
+
+    - Flexible: Duckwork that can be bent or adjusted easily. Suitable for tricky, tight spaces where rigid
+                ducts cannot be used.
+    - Rigid: Stiff ductwork, typically in fixed shapes. Commonly used for main duct runs due to its durability
+             and airflow efficiency.
+    - Semi-rigid: Less flexible than flexible ducts but not fixed. Balances flexibility and sturdiness,
+                  useful for certain architectural constraints. Used mostly in residential applications.
+    - Ductboard: Insulated panel-type ductwork made from fiberglass or other materials. It provides thermal insulation
+                 and is used where space is not a constraint.
+    """
+
+    FLEXIBLE = "Flexible"
+    RIGID = "Rigid"
+    SEMI_RIGID = "Semi-rigid"
+    DUCTBOARD = "Ductboard"
+
+
+class HvacDuctMaterial(StrEnum):
+    """
+    Hvac duct material.
+
+    - Galvanized Steel: coated with a layer of zinc to prevent rust. Very durable and common for both residential
+                        and commercial HVAC systems.
+    - Aluminum: lightweight and resistant to corrosion. Uncommon but preferred for special applications due
+                to its ease of handling and installation.
+    - PVC: Plastic ducts suitable for specific environments. Uncommon but used where moisture or chemical resistance
+           is needed. Not for high temperatures.
+    - Fiberglass: Insulated ducts that also absorb sound. Reduces noise and heat loss. Uncommon but suitable
+                  for sensitive environments.
+    - Fabric: Ducts made from specialized fabric materials. Used for distributing air uniformly, and in places
+              requiring diffused airflow.
+    """
+
+    GALVANIZED_STEEL = "Galvanized Steel"
+    ALUMINUM = "Aluminum"
+    PVC = "PVC"
+    FIBERGLASS = "Fiberglass"
+    FABRIC = "Fabric"
+
+
+class HvacDuctShape(StrEnum):
+    """
+    Hvac duct shape.
+
+    - Round: Cylindrical ducts providing efficient airflow. Minimizes friction losses, making it effective for long runs.
+    - Rectangular: Square or rectangular ducts, versatile installation. Common in commercial settings, easier
+                   to install in flat spaces.
+    - Oval: Combines attributes of round and rectangular shapes. Provides the benefits of round ducts
+            where space is limited.
+    """
+
+    ROUND = "Round"
+    RECTANGULAR = "Rectangular"
+    OVAL = "Oval"
+
+
 class HeatPumpType(StrEnum):
     """
     Heat pump type.

openepd/model/specs/generated/mechanical.py

@@ -23,6 +23,9 @@ from openepd.model.specs.generated.enums import (
     BoilerConfiguration,
     BoilerEquipmentFuelType,
     HeatPumpType,
+    HvacDuctMaterial,
+    HvacDuctShape,
+    HvacDuctType,
     HvacHeatExchangersType,
     MechanicalInstallation,
     MechanicalRefrigerants,
@@ -205,10 +208,22 @@ class HvacVrfSystemsV1(BaseOpenEpdHierarchicalSpec):
     HvacVrfOutdoor: HvacVrfOutdoorV1 | None = None
 
 
+class HvacDuctsV1(BaseOpenEpdHierarchicalSpec):
+    """Ducts for HVAC systems performance specification."""
+
+    _EXT_VERSION = "1.0"
+
+    shape: HvacDuctShape | None = pyd.Field(default=None, description="Hvac duct shape", example="Rectangular")
+    material: HvacDuctMaterial | None = pyd.Field(
+        default=None, description="Hvac duct material", example="Galvanized Steel"
+    )
+    type: HvacDuctType | None = pyd.Field(default=None, description="Hvac duct type", example="Flexible")
+
+
 class MechanicalV1(BaseOpenEpdHierarchicalSpec):
     """Mechanical performance specification."""
 
-    _EXT_VERSION = "1.0"
+    _EXT_VERSION = "1.1"
 
     # Nested specs:
     HvacAirDiffusers: HvacAirDiffusersV1 | None = None
@@ -222,3 +237,4 @@ class MechanicalV1(BaseOpenEpdHierarchicalSpec):
     HvacPumps: HvacPumpsV1 | None = None
     HvacRTUs: HvacRTUsV1 | None = None
     HvacVrfSystems: HvacVrfSystemsV1 | None = None
+    HvacDucts: HvacDuctsV1 | None = None

{openepd-4.6.0.dist-info → openepd-4.7.0.dist-info}/METADATA

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

{openepd-4.6.0.dist-info → openepd-4.7.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 openepd/__init__.py,sha256=Shkfh0Kun0YRhmRDw7LkUj2eQL3X-HnP55u2THOEALw,794
-openepd/__version__.py,sha256=Bxj3Ca48hb_OiFMyeAxnZuIFNvhflavMRqNuZEV96-4,638
+openepd/__version__.py,sha256=pMpg9-CrnTUE6GtcD2aL-Z8bPoVZ7HOk38EYJxrVfGo,638
 openepd/api/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
 openepd/api/base_sync_client.py,sha256=jviqtQgsOVdRq5x7_Yh_Tg8zIdWtVTIUqNCgebf6YDg,20925
 openepd/api/category/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
@@ -30,13 +30,13 @@ openepd/compat/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,62
 openepd/compat/compat_functional_validators.py,sha256=yz6DfWeg7knBHEN_enpCGGTLRknEsecXfpzD1FDlywY,834
 openepd/compat/pydantic.py,sha256=DOjSixsylLqMtFAIARu50sGcT4VPXN_c473q_2JwZQ0,1146
 openepd/model/__init__.py,sha256=UGmZGEyMnASrYwEBPHuXmVzHiuCUskUsJEPoHTIo-lg,620
-openepd/model/base.py,sha256=uVEGndgLm8JFwffsCXdusfRE01DQSKJUJLxsd-GXba0,8988
+openepd/model/base.py,sha256=Uy2Fh7Z9nPzrXrOn2aHPoJjktQfVOQ7UBCXiATkPfEQ,9008
 openepd/model/category.py,sha256=IQXNGQFQmFZ_H9PRONloX_UOSf1sTMDq1rM1yz8JR0Y,1639
 openepd/model/common.py,sha256=aa_bfotPybPoYyzHtwj5E5X1T-fCEyznMfVUWvpUhiM,5460
 openepd/model/declaration.py,sha256=5mzX24KpsezqBuGFAr-InsgB4FFNqI7HPJeDHQ93ZCI,5322
-openepd/model/epd.py,sha256=3fg6ex8hC4PLALEzYNp62kPKWXZuBwu86fdlv6-6PA4,10159
+openepd/model/epd.py,sha256=bhmPNWQQ28uhaoxE7sW8_mxyswSCEvGovQ2tH69jzUo,10324
 openepd/model/factory.py,sha256=StQUH7GNmRqskMnnRYkr_PLCl5X5sSLEPiYZOIQI9eo,2541
-openepd/model/generic_estimate.py,sha256=aNduYJ0oR1RCXamlbz1erORGKK-7jWIvl4eBJTmbq7g,4582
+openepd/model/generic_estimate.py,sha256=RSpQ4F4uVpwLg7NeymoX-V7c4vw3vbR5O4oObFON62A,4764
 openepd/model/geography.py,sha256=OngHXz-Dkg-NrVPIwNPP53xu4-HkQ_fnEfX5fYIVEfA,37417
 openepd/model/lcia.py,sha256=Cw4dwEy5Fb13XyYxpqQyGNhkuZNdjsjucAC7L1TAn7I,17560
 openepd/model/org.py,sha256=FHcYh2WOOQrCMyzm0Ow-iP79jMTBPcneidjH6NXIklA,3760
@@ -61,7 +61,7 @@ openepd/model/specs/generated/conveying_equipment.py,sha256=sQSnFccpTIw8sNGywW0K
 openepd/model/specs/generated/electrical.py,sha256=z4v6zbDvyMSYwbz7kb70aks1Ik9Q14ZkLss7cLqUdTs,10755
 openepd/model/specs/generated/electrical_transmission_and_distribution_equipment.py,sha256=h6UQixACOHrquhQ2GFqqYWel_zqOXT-vAkI0o_RLf0A,1978
 openepd/model/specs/generated/electricity.py,sha256=iGtN21K1MRVwoRfO6friVgiXc2b6cVdITbvnXqLmW3k,823
-openepd/model/specs/generated/enums.py,sha256=JaQZFGrGLPxz_J8t5VcSszM8HgmqHaIxqg9-nqFnv_k,58504
+openepd/model/specs/generated/enums.py,sha256=9JA9hay6s76kStmcAvpmF8NLgsYZA3IkNMRh-TMK2qY,60938
 openepd/model/specs/generated/finishes.py,sha256=QHFtUZcUCGAzZeHJlLoG1D9SxAW9FGPj7g48Fu1Nvdc,21660
 openepd/model/specs/generated/fire_and_smoke_protection.py,sha256=zkOlnNCnAZ9MUWk2sDqUX14YxNEDU3MGfUlePG3su0Q,3068
 openepd/model/specs/generated/furnishings.py,sha256=QY_FDsFZaqjCiw2xHsD3kmyBGJA7jCHlSIvaw4TmqXI,2581
@@ -69,7 +69,7 @@ openepd/model/specs/generated/grouting.py,sha256=mDpfsax6TO72SuBqv8HftJDYoQPP741
 openepd/model/specs/generated/manufacturing_inputs.py,sha256=B1_6OYX3cOFpOBvQRQrbPD4v9-iwKHo4E1fu9YfEDOo,5103
 openepd/model/specs/generated/masonry.py,sha256=35yUySGoRCApdZSYWbCjZ_rTR7WRPssz4patN8pqHNU,3069
 openepd/model/specs/generated/material_handling.py,sha256=hx8fisNcFw6GXC7uMfW-4wkGUS8xJA9gTk_WpZGHkqY,1274
-openepd/model/specs/generated/mechanical.py,sha256=RfW-HKNWCj6K-emQ6YjfaGU0MldrP9X7xXWlwYWTqeA,9277
+openepd/model/specs/generated/mechanical.py,sha256=qRKvOqRqn2DoyTCOnNwHClyoby0pa4YN8vXuE6CtY8A,9872
 openepd/model/specs/generated/mechanical_insulation.py,sha256=sbXTXT4xOOgvyDeLN4HZ3xCIwKkaPEjoQlRyCrq4tlM,1617
 openepd/model/specs/generated/network_infrastructure.py,sha256=GTdoFYj-ZU3rVqFrxb7hY5WzbyN3NnwtqnduH0wODeg,8157
 openepd/model/specs/generated/openings.py,sha256=cpJr0Qk9FTLktM5hQAOsPBFL36CRP2sKpe_1v1EOVG4,18818
@@ -91,7 +91,7 @@ openepd/model/validation/quantity.py,sha256=kzug0MZ3Ao0zeVzN-aleyxUg5hA_7D5tNOOe
 openepd/model/versioning.py,sha256=R_zm6rCrgF3vlJQYbpyWhirdS_Oek16cv_mvZmpuE8I,4473
 openepd/patch_pydantic.py,sha256=xrkzblatmU9HBzukWkp1cPq9ZSuohoz1p0pQqVKSlKs,4122
 openepd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openepd-4.6.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-4.6.0.dist-info/METADATA,sha256=qMG2uMUbdxqQf34jmCjDmHJI1nfG1R-37hDUpN_-jtg,8534
-openepd-4.6.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-openepd-4.6.0.dist-info/RECORD,,
+openepd-4.7.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openepd-4.7.0.dist-info/METADATA,sha256=cZp9von79AjPkfMiN8va1GOm7Imr7D73byVhyoYBlaI,8534
+openepd-4.7.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+openepd-4.7.0.dist-info/RECORD,,