openepd 0.2.0__tar.gz → 0.3.0__tar.gz

{openepd-0.2.0 → openepd-0.3.0}/PKG-INFO

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

{openepd-0.2.0 → openepd-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openepd"
-version = "0.2.0"
+version = "0.3.0"
 license = "Apache-2.0"
 description = "Python library to work with OpenEPD format"
 authors = ["C-Change Labs <support@c-change-labs.com>"]
@@ -56,7 +56,7 @@ types-deprecated = ">=1.2.9"
 
 
 [tool.commitizen]
-version = "0.2.0"
+version = "0.3.0"
 bump_version = "bump: version $current_version → $new_version"
 update_changelog_on_bump = true
 pre_bump_hooks = []

{openepd-0.2.0 → openepd-0.3.0}/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 = "0.2.0"
+VERSION = "0.3.0"

{openepd-0.2.0 → openepd-0.3.0}/src/openepd/model/base.py

@@ -26,11 +26,13 @@ AnySerializable = int | str | bool | float | list | dict | pydantic.BaseModel |
 class BaseOpenEpdSchema(pydantic.BaseModel):
     """Base class for all OpenEPD models."""
 
-    extensions: dict[str, AnySerializable] | None = pydantic.Field(alias="ext", default=None)
+    ext: dict[str, AnySerializable] | None = pydantic.Field(alias="ext", default=None)
 
     class Config:
         allow_mutation = True
         validate_assignment = False
+        allow_population_by_field_name = True
+        use_enum_values = True
 
     def has_values(self) -> bool:
         """Return True if the model has any values."""
@@ -56,3 +58,9 @@ class BaseOpenEpdGenericSchema(GenericModel, BaseOpenEpdSchema):
     """Base class for all OpenEPD generic models."""
 
     pass
+
+
+class BaseOpenEpdSpec(BaseOpenEpdSchema):
+    """Base class for all OpenEPD specs."""
+
+    pass

{openepd-0.2.0 → openepd-0.3.0}/src/openepd/model/epd.py

@@ -24,8 +24,10 @@ import pydantic as pyd
 
 from openepd.model.base import BaseOpenEpdSchema
 from openepd.model.common import Amount
-from openepd.model.lcia import ImpactSet, OutputFlowSet, ResourceUseSet, Standard
+from openepd.model.lcia import ImpactSet, OutputFlowSet, ResourceUseSet
 from openepd.model.org import Org, Plant
+from openepd.model.specs import Specs
+from openepd.model.standard import Standard
 
 
 class Epd(BaseOpenEpdSchema):
@@ -123,3 +125,34 @@ class Epd(BaseOpenEpdSchema):
     compliance: list[Standard] = pyd.Field(
         description="Standard(s) to which this declaration is compliant.", default_factory=list
     )
+    specs: Specs = pyd.Field(
+        default_factory=Specs,
+        description="Data structure(s) describing performance specs of product. Unique for each material type.",
+    )
+    lca_discussion: str | None = pyd.Field(
+        max_length=20000,
+        description="""A rich text description containing information for experts reviewing the EPD contents. 
+    Text descriptions required by ISO 14025, ISO 21930, EN 15804,, relevant PCRs, or program instructions and which do not 
+    have specific openEPD fields should be entered here.  This field may be large, and may contain multiple sections 
+    separated by github flavored markdown formatting.""",
+        example="""# Packaging
+
+    Information on product-specific packaging: type, composition and possible reuse of packaging materials (paper, 
+    strapping, pallets, foils, drums, etc.) shall be included in this Section. The EPD shall describe specific packaging 
+    scenario assumptions, including disposition pathways for each packaging material by reuse, recycling, or landfill 
+    disposal based on packaging type.*
+
+    # Product Installation
+
+    A description of the type of processing, machinery, tools, dust extraction equipment, auxiliary materials, etc. 
+    to be used during installation shall be included. Information on industrial and environmental protection may be 
+    included in this section. Any waste treatment included within the system boundary of installation waste should be 
+    specified.
+
+    # Use Conditions
+
+    Use-stage environmental impacts of flooring products during building operations depend on product cleaning assumptions. 
+    Information on cleaning frequency and cleaning products shall be provided based on the manufacturer’s recommendations. 
+    In the absence of primary data, cleaning assumptions shall be documented.
+    """,
+    )

{openepd-0.2.0 → openepd-0.3.0}/src/openepd/model/lcia.py

@@ -21,7 +21,6 @@ import pydantic as pyd
 
 from openepd.model.base import BaseOpenEpdSchema
 from openepd.model.common import Measurement
-from openepd.model.org import Org
 
 
 class EolScenario(BaseOpenEpdSchema):
@@ -168,14 +167,3 @@ class OutputFlowSet(BaseOpenEpdSchema):
     """A set of output flows, such as waste, emissions, etc."""
 
     hwd: ScopeSet | None = pyd.Field(description="Hazardous waste disposed")
-
-
-class Standard(BaseOpenEpdSchema):
-    """A standard, such as EN 15804, ISO 14044, ISO 14024:2018, etc."""
-
-    short_name: str = pyd.Field(description="Short-form of name of standard.  Must be unique. Case-insensitive")
-    name: str | None = pyd.Field(description="Full document name.  Must be unique. Case-insensitive", default=None)
-    link: pyd.AnyUrl | None = pyd.Field(
-        description="Link to the exact standard (including version) referred to", default=None
-    )
-    issuer: Org | None = pyd.Field(description="Org that issued this standard", default=None)

openepd-0.3.0/src/openepd/model/specs/__init__.py

@@ -0,0 +1,29 @@
+#
+#  Copyright 2023 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.
+#
+#  This software was developed with support from the Skanska USA,
+#  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
+#  Find out more at www.BuildingTransparency.org
+#
+import pydantic as pyd
+
+from openepd.model.base import BaseOpenEpdSchema
+from openepd.model.specs.concrete import CmuSpec
+
+
+class Specs(BaseOpenEpdSchema):
+    """Material specific specs."""
+
+    cmu: CmuSpec | None = pyd.Field(default=None, description="Concrete Masonry Unit-specific (CMU) specs")

openepd-0.3.0/src/openepd/model/specs/concrete.py

@@ -0,0 +1,83 @@
+#
+#  Copyright 2023 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.
+#
+#  This software was developed with support from the Skanska USA,
+#  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
+#  Find out more at www.BuildingTransparency.org
+#
+from enum import StrEnum
+
+import pydantic as pyd
+
+from openepd.model.base import BaseOpenEpdSpec
+
+
+class CmuWeightClassification(StrEnum):
+    """Concrete Masonry Unit weight classification."""
+
+    Normal = "Normal"
+    """Normal weight CMU has a density of 125 lbs/cu. ft."""
+    Medium = "Medium"
+    """Medium weight CMU has a density of 105-125 lbs/cu. ft."""
+    Light = "Light"
+    """Lightweight CMU has a density less than 105 lbs/cu. ft."""
+
+
+class CmuOptions(BaseOpenEpdSpec):
+    """Concrete Masonry Unit options."""
+
+    load_bearing: bool | None = pyd.Field(
+        description="Load-Bearing. CMUs intended to be loadbearing, rather than simply cosmetic",
+        example=True,
+        default=None,
+    )
+    aerated_concrete: bool | None = pyd.Field(
+        description="AAC Aerated Concrete. Aerated Autoclaved Concrete, a foam concrete.", example=True, default=None
+    )
+    insulated: bool | None = pyd.Field(
+        description="Insulated. CMUs with integral insulation", example=True, default=None
+    )
+    sound_absorbing: bool | None = pyd.Field(
+        description="Sound Absorbing. CMUs structured for sound absorbtion", example=True, default=None
+    )
+    white: bool | None = pyd.Field(
+        description="White. CMU using white cement and light-colored aggregate", example=True, default=None
+    )
+    recycled_aggregate: bool | None = pyd.Field(
+        description="Recycled aggregate. CMU using primarily reycled aggregates", example=True, default=None
+    )
+    groundface: bool | None = pyd.Field(
+        description="Ground Face. Ground or Honed facing, typically for improved appearance", example=True, default=None
+    )
+    splitface: bool | None = pyd.Field(
+        description="Splitface. Rough surface texture via splitting; aggregate can be seen", example=True, default=None
+    )
+    smoothface: bool | None = pyd.Field(
+        description="Smooth Face. Standard smooth-faced blocks", example=True, default=None
+    )
+    slumpstone: bool | None = pyd.Field(
+        description="Slumpstone. A slightly rounded, random distortion with the look of rustic adobe.",
+        example=True,
+        default=None,
+    )
+
+
+class CmuSpec(BaseOpenEpdSpec):
+    """Standardized Concrete Masonry Unit-specific extension for OpenEPD."""
+
+    strength: str = pyd.Field(description="Compressive strength", example="4000 psi")
+    options: CmuOptions = pyd.Field(
+        description="Options for CMU. List of true/false properties", default_factory=CmuOptions
+    )

openepd-0.3.0/src/openepd/model/standard.py

@@ -0,0 +1,34 @@
+#
+#  Copyright 2023 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.
+#
+#  This software was developed with support from the Skanska USA,
+#  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
+#  Find out more at www.BuildingTransparency.org
+#
+import pydantic as pyd
+
+from openepd.model.base import BaseOpenEpdSchema
+from openepd.model.org import Org
+
+
+class Standard(BaseOpenEpdSchema):
+    """A standard, such as EN 15804, ISO 14044, ISO 14024:2018, etc."""
+
+    short_name: str = pyd.Field(description="Short-form of name of standard.  Must be unique. Case-insensitive")
+    name: str | None = pyd.Field(description="Full document name.  Must be unique. Case-insensitive", default=None)
+    link: pyd.AnyUrl | None = pyd.Field(
+        description="Link to the exact standard (including version) referred to", default=None
+    )
+    issuer: Org | None = pyd.Field(description="Org that issued this standard", default=None)