openepd 0.1.3__py3-none-any.whl → 0.3.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 = "0.1.3"
+VERSION = "0.3.0"

openepd/model/base.py

@@ -20,20 +20,47 @@
 import pydantic
 from pydantic.generics import GenericModel
 
+AnySerializable = int | str | bool | float | list | dict | pydantic.BaseModel | None
+
 
 class BaseOpenEpdSchema(pydantic.BaseModel):
     """Base class for all OpenEPD models."""
 
+    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."""
         return len(self.dict(exclude_unset=True, exclude_none=True)) > 0
 
+    @classmethod
+    def is_allowed_field_name(cls, field_name: str) -> bool:
+        """
+        Return True if the field name is defined in the module.
+
+        Both property name and aliases are checked.
+        """
+        if field_name in cls.__fields__:
+            return True
+        else:
+            for x in cls.__fields__.values():
+                if x.alias == field_name:
+                    return True
+        return False
+
 
 class BaseOpenEpdGenericSchema(GenericModel, BaseOpenEpdSchema):
     """Base class for all OpenEPD generic models."""
 
     pass
+
+
+class BaseOpenEpdSpec(BaseOpenEpdSchema):
+    """Base class for all OpenEPD specs."""
+
+    pass

openepd/model/common.py

@@ -36,21 +36,10 @@ class Measurement(BaseOpenEpdSchema):
 
     mean: float = pyd.Field(description="Mean (expected) value of the measurement")
     unit: str = pyd.Field(description="Measurement unit")
-    rsd: pyd.PositiveFloat = pyd.Field(description="Relative standard deviation, i.e. standard_deviation/mean")
-    dist: str | None = pyd.Field(description="Statistical distribution of the measurement error.")
-
-
-class ExternalIdentification(BaseOpenEpdSchema):  # TODO: NEW Object, not in the spec
-    """Represent an external identification of an object."""
-
-    id: str
-    version: str | None
-
-
-class ExternallyIdentifiableMixin:  # TODO: NEW Object, not in the spec
-    """Mixin for objects that can be identified externally."""
-
-    identified: dict[str, ExternalIdentification] = pyd.Field(description="The external identification of the object.")
+    rsd: pyd.PositiveFloat | None = pyd.Field(
+        description="Relative standard deviation, i.e. standard_deviation/mean", default=None
+    )
+    dist: str | None = pyd.Field(description="Statistical distribution of the measurement error.", default=None)
 
 
 class WithAttachmentsMixin:

openepd/model/epd.py

@@ -23,12 +23,14 @@ from typing import Literal
 import pydantic as pyd
 
 from openepd.model.base import BaseOpenEpdSchema
-from openepd.model.common import Amount, ExternallyIdentifiableMixin
+from openepd.model.common import Amount
 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(ExternallyIdentifiableMixin, BaseOpenEpdSchema):
+class Epd(BaseOpenEpdSchema):
     """Represent an EPD."""
 
     # TODO: Add validator for open-xpd-uuid on this field
@@ -120,3 +122,37 @@ class Epd(ExternallyIdentifiableMixin, BaseOpenEpdSchema):
         description="Set of Waste and Output Flow indicators which describe the waste categories "
         "and other material output flows derived from the LCI."
     )
+    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/model/org.py

@@ -22,7 +22,7 @@ from typing import Annotated, Optional
 import pydantic as pyd
 
 from openepd.model.base import BaseOpenEpdSchema
-from openepd.model.common import ExternallyIdentifiableMixin, WithAttachmentsMixin
+from openepd.model.common import WithAttachmentsMixin
 
 
 class Contact(BaseOpenEpdSchema):  # TODO: NEW Object, not in the spec
@@ -35,9 +35,7 @@ class Contact(BaseOpenEpdSchema):  # TODO: NEW Object, not in the spec
     )
 
 
-class Org(
-    ExternallyIdentifiableMixin, WithAttachmentsMixin, BaseOpenEpdSchema
-):  # TODO: NEW Identifiable field, not in the spec
+class Org(WithAttachmentsMixin, BaseOpenEpdSchema):  # TODO: NEW Identifiable field, not in the spec
     """Represent an organization."""
 
     web_domain: str = pyd.Field(
@@ -59,7 +57,7 @@ class Org(
     )
 
 
-class Plant(ExternallyIdentifiableMixin, WithAttachmentsMixin, BaseOpenEpdSchema):
+class Plant(WithAttachmentsMixin, BaseOpenEpdSchema):
     """Represent a manufacturing plant."""
 
     # TODO: Add proper validator

openepd/model/pcr.py

@@ -23,11 +23,11 @@ from typing import Optional
 import pydantic as pyd
 
 from openepd.model.base import BaseOpenEpdSchema
-from openepd.model.common import ExternallyIdentifiableMixin, WithAttachmentsMixin
+from openepd.model.common import WithAttachmentsMixin
 from openepd.model.org import Org
 
 
-class Pcr(ExternallyIdentifiableMixin, WithAttachmentsMixin, BaseOpenEpdSchema):
+class Pcr(WithAttachmentsMixin, BaseOpenEpdSchema):
     """Represent a PCR (Product Category Rules)."""
 
     id: str = pyd.Field(

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/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/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)

{openepd-0.1.3.dist-info → openepd-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openepd
-Version: 0.1.3
+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.3.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+openepd/__init__.py,sha256=7_QNx3x9RCC7Lj9fHDD3nzgq6wV4Fmou7OJNWkCPnEw,837
+openepd/__version__.py,sha256=M9l7ZzgmpFsB59avClU0_PB_PUhypOp28sEbL1pAGQU,855
+openepd/model/__init__.py,sha256=7_QNx3x9RCC7Lj9fHDD3nzgq6wV4Fmou7OJNWkCPnEw,837
+openepd/model/base.py,sha256=Dpc8YeGf70gHahGrLbCC2e4MFCI6BHoByNSGdN3Ul7c,2155
+openepd/model/common.py,sha256=DomuW6IRVyOpbo-wJbrPpWa7ig65OzAncSzA63Imyy8,2178
+openepd/model/epd.py,sha256=_BZoLHOz8uDL0lDqHAYgPxOiJ39hHfWCbVAdXqIhWWk,7763
+openepd/model/lcia.py,sha256=N_2TukAXKCz5ztWHRdOrw2UVmAhLn9WN9x9y6_BJ6Uw,8887
+openepd/model/org.py,sha256=kQyaCi6pRzaThJ_13o4ymEfNoSBXXZP0wVoZA7mse6o,3690
+openepd/model/pcr.py,sha256=RmOB9YLkNJIU1RAvHSDzOOIL3ux3FmJo60oCkXXu_08,2855
+openepd/model/specs/__init__.py,sha256=JmbvfzwO0QmNcrxGqYE_KjvYHBmc2bnDm7cyZsaMG78,1137
+openepd/model/specs/concrete.py,sha256=v9Jyi6NiaoMA2ELX_wMckgTAtRplEOaIkZrd2qEdiN4,3342
+openepd/model/standard.py,sha256=Nv_H3Lhu79y4waWzzKpwODCPPGrlWwRIl6eZBMSc9Qg,1519
+openepd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+openepd-0.3.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openepd-0.3.0.dist-info/METADATA,sha256=ASVre0j0f1CKolSXk10wzB6FmSros-KnUoiw3IbVvuM,3723
+openepd-0.3.0.dist-info/WHEEL,sha256=WGfLGfLX43Ei_YORXSnT54hxFygu34kMpcQdmgmEwCQ,88
+openepd-0.3.0.dist-info/RECORD,,

openepd-0.1.3.dist-info/RECORD

@@ -1,14 +0,0 @@
-openepd/__init__.py,sha256=7_QNx3x9RCC7Lj9fHDD3nzgq6wV4Fmou7OJNWkCPnEw,837
-openepd/__version__.py,sha256=T87cqTOIorCpfwNyvo0jvQ5LS27mv02hQMmtN92zYkU,855
-openepd/model/__init__.py,sha256=7_QNx3x9RCC7Lj9fHDD3nzgq6wV4Fmou7OJNWkCPnEw,837
-openepd/model/base.py,sha256=2kaIyTze9V0ItX-yNFFHGRIF3ewDuoF_GGbYbfAT_iI,1366
-openepd/model/common.py,sha256=_Vn2ysWrJFYHZKBe8cxnPhV45RR3KzIPjfKXLPJOTVA,2573
-openepd/model/epd.py,sha256=5KvTvG3uX5hhVyp9iuDhjz_8fgVV8IC4wextNToVoiU,5740
-openepd/model/lcia.py,sha256=N_2TukAXKCz5ztWHRdOrw2UVmAhLn9WN9x9y6_BJ6Uw,8887
-openepd/model/org.py,sha256=k3fpFwVPnN80UIJJFu-kPUCIyD2iIavtDeTCKwGTFIg,3783
-openepd/model/pcr.py,sha256=vEwd2V6IFau1vXC8MC8Ptx6YXySrFgOuiho_J1ZxhJg,2913
-openepd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openepd-0.1.3.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-0.1.3.dist-info/METADATA,sha256=H_SXczzF5ijpPxydL3XQ5FGEVuLAWVfkNcz5onAu4ig,3723
-openepd-0.1.3.dist-info/WHEEL,sha256=WGfLGfLX43Ei_YORXSnT54hxFygu34kMpcQdmgmEwCQ,88
-openepd-0.1.3.dist-info/RECORD,,