openepd 4.6.0__tar.gz → 4.7.0__tar.gz

{openepd-4.6.0 → openepd-4.7.0}/PKG-INFO

@@ -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 → openepd-4.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openepd"
-version = "4.6.0"
+version = "4.7.0"
 license = "Apache-2.0"
 description = "Python library to work with OpenEPD format"
 authors = ["C-Change Labs <support@c-change-labs.com>"]

{openepd-4.6.0 → openepd-4.7.0}/src/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-4.6.0 → openepd-4.7.0}/src/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-4.6.0 → openepd-4.7.0}/src/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-4.6.0 → openepd-4.7.0}/src/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-4.6.0 → openepd-4.7.0}/src/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-4.6.0 → openepd-4.7.0}/src/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