openepd 0.10.0__tar.gz → 0.11.1__tar.gz

{openepd-0.10.0 → openepd-0.11.1}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: openepd
-Version: 0.10.0
+Version: 0.11.1
 Summary: Python library to work with OpenEPD format
 Home-page: https://github.com/cchangelabs/openepd
 License: Apache-2.0
 Author: C-Change Labs
 Author-email: support@c-change-labs.com
 Maintainer: C-Change Labs
-Maintainer-email: support@c-change-labs.com
+Maintainer-email: open-source@c-change-labs.com
 Requires-Python: >=3.11,<4.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers

{openepd-0.10.0 → openepd-0.11.1}/pyproject.toml

@@ -1,10 +1,10 @@
 [tool.poetry]
 name = "openepd"
-version = "0.10.0"
+version = "0.11.1"
 license = "Apache-2.0"
 description = "Python library to work with OpenEPD format"
 authors = ["C-Change Labs <support@c-change-labs.com>"]
-maintainers = ["C-Change Labs <support@c-change-labs.com>"]
+maintainers = ["C-Change Labs <open-source@c-change-labs.com>"]
 repository = "https://github.com/cchangelabs/openepd"
 keywords = []
 classifiers = [
@@ -34,9 +34,9 @@ pytest = "~=7.2"
 pytest-subtests = "~=0.4"
 pytest-cov = "~=4.0"
 teamcity-messages = ">=1.31"
+wheel = "~=0.40.0"
 
 # Dev tools
-#virtualenv = "<=20.23.0" # to avoid conflict with flake plugins
 black = "~=22.3"
 licenseheaders = "~=0.8"
 flake8 = "~=4.0"
@@ -56,7 +56,7 @@ types-deprecated = ">=1.2.9"
 
 
 [tool.commitizen]
-version = "0.10.0"
+version = "0.11.1"
 bump_version = "bump: version $current_version → $new_version"
 update_changelog_on_bump = true
 pre_bump_hooks = []

{openepd-0.10.0 → openepd-0.11.1}/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.10.0"
+VERSION = "0.11.1"

{openepd-0.10.0 → openepd-0.11.1}/src/openepd/model/base.py

@@ -18,7 +18,8 @@
 #  Find out more at www.BuildingTransparency.org
 #
 import abc
-from typing import Optional, Type, TypeVar
+import json
+from typing import Any, Optional, Type, TypeVar
 
 import pydantic
 from pydantic.generics import GenericModel
@@ -38,6 +39,14 @@ class BaseOpenEpdSchema(pydantic.BaseModel):
         allow_population_by_field_name = True
         use_enum_values = True
 
+    def to_serializable(self, *args, **kwargs) -> dict[str, Any]:
+        """
+        Return a serializable dict representation of the DTO.
+
+        It expects the same arguments as the pydantic.BaseModel.json() method.
+        """
+        return json.loads(self.json(*args, **kwargs))
+
     def has_values(self) -> bool:
         """Return True if the model has any values."""
         return len(self.dict(exclude_unset=True, exclude_none=True)) > 0
@@ -72,6 +81,8 @@ class BaseOpenEpdSchema(pydantic.BaseModel):
         :raise ValueError: if the value cannot be converted to the target type.
         """
         value = self.get_ext_field(key, default)
+        if value is None:
+            return None  # type: ignore
         if issubclass(target_type, pydantic.BaseModel) and isinstance(value, dict):
             return target_type.construct(**value)  # type: ignore
         elif isinstance(value, target_type):

{openepd-0.10.0 → openepd-0.11.1}/src/openepd/model/common.py

@@ -73,6 +73,25 @@ class Ingredient(BaseOpenEpdSchema):
     )
 
 
+class LatLng(BaseOpenEpdSchema):
+    """A latitude and longitude."""
+
+    lat: float = pyd.Field(description="Latitude", example=47.6062)
+    lng: float = pyd.Field(description="Longitude", example=-122.3321)
+
+
+class Location(BaseOpenEpdSchema):
+    """A location on the Earth's surface."""
+
+    pluscode: str | None = pyd.Field(default=None, description="Open Location code of this location")
+    latlng: LatLng | None = pyd.Field(default=None, description="Latitude and longitude of this location")
+    address: str | None = pyd.Field(default=None, description="Text address, preferably geocoded")
+    country: str | None = pyd.Field(default=None, description="2-alpha country code")
+    jurisdiction: str | None = pyd.Field(
+        default=None, description="Province, State, or similar subdivision below the level of a country"
+    )
+
+
 class WithAttachmentsMixin(BaseModel):
     """Mixin for objects that can have attachments."""
 

{openepd-0.10.0 → openepd-0.11.1}/src/openepd/model/epd.py

@@ -18,7 +18,7 @@
 #  Find out more at www.BuildingTransparency.org
 #
 import datetime
-from typing import Annotated, Literal
+from typing import Annotated
 
 import pydantic as pyd
 
@@ -35,16 +35,17 @@ class Epd(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
     """Represent an EPD."""
 
     # TODO: Add validator for open-xpd-uuid on this field
-    id: str = pyd.Field(
+    id: str | None = pyd.Field(
         description="The unique ID for this EPD.  To ensure global uniqueness, should be registered at "
         "open-xpd-uuid.cqd.io/register or a coordinating registry.",
         example="1u7zsed8",
+        default=None,
     )
-    doctype: Literal["OpenEPD", "ILCD_EPD"] = pyd.Field(
+    doctype: str = pyd.Field(
         description='Describes the type and schema of the document. Must always always read "openEPD".',
         default="OpenEPD",
     )
-    product_name: str = pyd.Field(
+    product_name: str | None = pyd.Field(
         max_length=200, description="The name of the product described by this EPD", example="Mix 12345AC"
     )
     product_sku: str | None = pyd.Field(
@@ -64,10 +65,11 @@ class Epd(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
     product_image: pyd.AnyUrl | None = pyd.Field(
         description="pointer to image illustrating the product no more than 10MB", default=None
     )
-    version: pyd.PositiveInt = pyd.Field(
+    version: pyd.PositiveInt | None = pyd.Field(
         description="Version of this document. The document's issuer should increment it anytime even a single "
         "character changes, as this value is used to determine the most recent version.",
         example=1,
+        default=None,
     )
     language: str | None = pyd.Field(
         min_length=2,
@@ -89,11 +91,20 @@ class Epd(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
         description="Link to data object on original registrar's site",
         example="https://epd-online.com/EmbeddedEpdList/Download/6029",
     )
-    # ilcd_uuid: str | None = pyd.Field(description="An optional UUID (for use with ILCD and similar systems)")
     manufacturer: Org | None = pyd.Field(
         description="JSON object for declaring Org. Sometimes called the "
         '"Declaration Holder" or "Declaration Owner".'
     )
+    epd_developer: Org | None = pyd.Field(
+        description="The organization responsible for the underlying LCA (and subsequent summarization as EPD).",
+        default=None,
+    )
+    epd_developer_email: pyd.EmailStr | None = pyd.Field(
+        default=None,
+        example="john.doe@we-do-lca.com",
+        description="Email contact for inquiries about development of this EPD. "
+        "This must be an email which can be publicly shared.",
+    )
     plants: list[Plant] = pyd.Field(
         max_items=32,
         description="List of object(s) for one or more plant(s) that this declaration applies to.",
@@ -113,6 +124,9 @@ class Epd(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
         description="Optional link to a verification statement.",
         example="https://we-verify-epds.com/en/letters/123-456.789b.pdf",
     )
+    third_party_verifier_email: pyd.EmailStr | None = pyd.Field(
+        description="Email address of the third party verifier", example="john.doe@example.com", default=None
+    )
     date_of_issue: datetime.date | None = pyd.Field(
         example=datetime.date(day=11, month=9, year=2019),
         description="Date the EPD was issued. This should be the first day on which the EPD is valid.",
@@ -212,6 +226,7 @@ class Epd(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
         max_items=255,
         description="List of JSON objects pointing to product components. "
         "Each one should be an EPD or digitized LCI process.",
+        default_factory=list,
     )
     lca_discussion: str | None = pyd.Field(
         max_length=20000,

{openepd-0.10.0 → openepd-0.11.1}/src/openepd/model/lcia.py

@@ -42,14 +42,28 @@ class EolScenario(BaseOpenEpdSchema):
         description="The weigting of this scenario used in the C1 .. C4 dataset. For example, the overall C1 shoudl be "
         "equal to weighted sum of C1 from all the scenarios, weighted by likelihood.",
         example=0.33,
+        default=None,
+    )
+    C1: Measurement | None = pyd.Field(
+        description="Deconstruction and Demolition under this scenario",
+        default=None,
+    )
+    C2: Measurement | None = pyd.Field(
+        description="Transport to waste processing or disposal under this scenario.",
+        default=None,
+    )
+    C3: Measurement | None = pyd.Field(
+        description="Waste Processing under this scenario",
+        default=None,
+    )
+    C4: Measurement | None = pyd.Field(
+        description="Disposal under this scenario",
+        default=None,
     )
-    C1: Measurement | None = pyd.Field(description="Deconstruction and Demolition under this scenario")
-    C2: Measurement | None = pyd.Field(description="Transport to waste processing or disposal under this scenario.")
-    C3: Measurement | None = pyd.Field(description="Waste Processing under this scenario")
-    C4: Measurement | None = pyd.Field(description="Disposal under this scenario")
     D: Measurement | None = pyd.Field(
         description="Potential net benefits from reuse, recycling, and/or energy recovery beyond "
-        "the system boundary under this scenario"
+        "the system boundary under this scenario",
+        default=None,
     )
 
 
@@ -61,50 +75,128 @@ class ScopeSet(BaseOpenEpdSchema):
     The 'unit' field must be consistent across all scopes in a single scopeset.
     """
 
-    A1A2A3: Measurement | None = pyd.Field(description="Sum of A1..A3")
-    A1: Measurement | None = pyd.Field(description="Raw Material Supply")
-    A2: Measurement | None = pyd.Field(description="Transport to Manufacturing")
-    A3: Measurement | None = pyd.Field(description="Manufacturing")
-    A4: Measurement | None = pyd.Field(description="Transport to Construction")
-    A5: Measurement | None = pyd.Field(description="Construction")
-    B1: Measurement | None = pyd.Field(description="Use impacts over Reference Service Life (Predicted)")
+    A1A2A3: Measurement | None = pyd.Field(
+        description="Sum of A1..A3",
+        default=None,
+    )
+    A1: Measurement | None = pyd.Field(
+        description="Raw Material Supply",
+        default=None,
+    )
+    A2: Measurement | None = pyd.Field(
+        description="Transport to Manufacturing",
+        default=None,
+    )
+    A3: Measurement | None = pyd.Field(
+        description="Manufacturing",
+        default=None,
+    )
+    A4: Measurement | None = pyd.Field(
+        description="Transport to Construction",
+        default=None,
+    )
+    A5: Measurement | None = pyd.Field(
+        description="Construction",
+        default=None,
+    )
+    B1: Measurement | None = pyd.Field(
+        description="Use impacts over Reference Service Life (Predicted)",
+        default=None,
+    )
     B1_years: float | None = pyd.Field(
         gt=0,
         lt=11,
         description="Timeframe over which B1 is evaluated, in years. "
         "For example, an impact of 1.23 kgCO2e per year for ten years could be B1=1.23kgCO2e, "
         "B1_years=1.0 or  B1=12.3kgCO2e, B1_years=10.0",
+        default=None,
+    )
+    B2: Measurement | None = pyd.Field(
+        description="Predicted Maintenance Impacts over Reference Service Life",
+        default=None,
     )
-    B2: Measurement | None = pyd.Field(description="Predicted Maintenance Impacts over Reference Service Life")
     B2_years: float | None = pyd.Field(
-        gt=0, lt=11, description="Predicted Maintenance Impacts over Reference Service Life"
+        gt=0,
+        lt=11,
+        description="Predicted Maintenance Impacts over Reference Service Life",
+        default=None,
+    )
+    B3: Measurement | None = pyd.Field(
+        description="Predicted Repair impacts over Reference Service Life",
+        default=None,
+    )
+    B3_years: float | None = pyd.Field(
+        gt=0,
+        lt=11,
+        description="Timeframe over which B3 is evaluated, in years",
+        default=None,
     )
-    B3: Measurement | None = pyd.Field(description="Predicted Repair impacts over Reference Service Life")
-    B3_years: float | None = pyd.Field(gt=0, lt=11, description="Timeframe over which B3 is evaluated, in years")
     B4: Measurement | None = pyd.Field(
         description="Predicted Replacement Impacts over the Building lifetime "
-        "('Estimated Construction Works lifespan') specified in the PCR."
+        "('Estimated Construction Works lifespan') specified in the PCR.",
+        default=None,
+    )
+    B4_years: float | None = pyd.Field(
+        gt=0,
+        lt=11,
+        description="Timeframe over which B4 is evaluated, in years",
+        default=None,
     )
-    B4_years: float | None = pyd.Field(gt=0, lt=11, description="Timeframe over which B4 is evaluated, in years")
     B5: Measurement | None = pyd.Field(
         description="Predicted Refurbishment Impacts over the Building lifetime "
-        "('Estimated Construction Works lifespan') specified in the PCR."
+        "('Estimated Construction Works lifespan') specified in the PCR.",
+        default=None,
+    )
+    B5_years: float | None = pyd.Field(
+        gt=0,
+        lt=11,
+        description="Timeframe over which B5 is evaluated, in years",
+        default=None,
+    )
+    B6: Measurement | None = pyd.Field(
+        description="Predicted Impacts related to Operational Energy Use",
+        default=None,
+    )
+    B6_years: float | None = pyd.Field(
+        gt=0,
+        lt=11,
+        description="Timeframe over which B6 is evaluated, in years",
+        default=None,
+    )
+    B7: Measurement | None = pyd.Field(
+        description="Predicted Impacts related to Operational Water Use",
+        default=None,
+    )
+    B7_years: float | None = pyd.Field(
+        gt=0,
+        lt=11,
+        description="Timeframe over which B7 is evaluated, in years",
+        default=None,
     )
-    B5_years: float | None = pyd.Field(gt=0, lt=11, description="Timeframe over which B5 is evaluated, in years")
-    B6: Measurement | None = pyd.Field(description="Predicted Impacts related to Operational Energy Use")
-    B6_years: float | None = pyd.Field(gt=0, lt=11, description="Timeframe over which B6 is evaluated, in years")
-    B7: Measurement | None = pyd.Field(description="Predicted Impacts related to Operational Water Use")
-    B7_years: float | None = pyd.Field(gt=0, lt=11, description="Timeframe over which B7 is evaluated, in years")
     C_scenarios: list[EolScenario] | None = pyd.Field(
         description="A list of possible end-of-life scenarios, "
-        "for use in analyses where the end-of-life can be predicted."
+        "for use in analyses where the end-of-life can be predicted.",
+        default=None,
+    )
+    C1: Measurement | None = pyd.Field(
+        description="Deconstruction and Demolition",
+        default=None,
+    )
+    C2: Measurement | None = pyd.Field(
+        description="Transport to waste processing or disposal.",
+        default=None,
+    )
+    C3: Measurement | None = pyd.Field(
+        description="Waste Processing",
+        default=None,
+    )
+    C4: Measurement | None = pyd.Field(
+        description="Disposal",
+        default=None,
     )
-    C1: Measurement | None = pyd.Field(description="Deconstruction and Demolition")
-    C2: Measurement | None = pyd.Field(description="Transport to waste processing or disposal.")
-    C3: Measurement | None = pyd.Field(description="Waste Processing")
-    C4: Measurement | None = pyd.Field(description="Disposal")
     D: Measurement | None = pyd.Field(
-        description="Potential net benefits from reuse, recycling, and/or energy recovery beyond the system boundary."
+        default=None,
+        description="Potential net benefits from reuse, recycling, and/or energy recovery beyond the system boundary.",
     )
 
 
@@ -112,26 +204,28 @@ class ImpactSet(BaseOpenEpdSchema):
     """A set of impacts, such as GWP, ODP, AP, EP, POCP, EP-marine, EP-terrestrial, EP-freshwater, etc."""
 
     gwp: ScopeSet | None = pyd.Field(
+        default=None,
         description="GWP100, calculated per IPCC guidelines.  If any CO2 removals are "
         "part of this figure, the gwp-fossil, gwp-bioganic, gwp-luluc, an "
         "gwp-nonCO2 fields are required, as is "
-        "kg_C_biogenic_per_declared_unit."
+        "kg_C_biogenic_per_declared_unit.",
     )
-    odp: ScopeSet | None = pyd.Field(description="Ozone Depletion Potential")
-    ap: ScopeSet | None = pyd.Field(description="Acidification Potential")
+    odp: ScopeSet | None = pyd.Field(default=None, description="Ozone Depletion Potential")
+    ap: ScopeSet | None = pyd.Field(default=None, description="Acidification Potential")
     ep: ScopeSet | None = pyd.Field(
-        description="Eutrophication Potential in Marine Ecosystems. Has the same meaning as ep-marine."
+        default=None, description="Eutrophication Potential in Marine Ecosystems. Has the same meaning as ep-marine."
     )
-    pocp: ScopeSet | None = pyd.Field(description="Photochemical Smog (Ozone) creation potential")
-    ep_marine: ScopeSet | None = pyd.Field(alias="ep-marine", description="Has the same meaning as 'ep'")
+    pocp: ScopeSet | None = pyd.Field(default=None, description="Photochemical Smog (Ozone) creation potential")
+    ep_marine: ScopeSet | None = pyd.Field(alias="ep-marine", default=None, description="Has the same meaning as 'ep'")
     ep_fresh: ScopeSet | None = pyd.Field(
-        alias="ep-fresh", description="Eutrophication Potential in Freshwater Ecosystems"
+        alias="ep-fresh", default=None, description="Eutrophication Potential in Freshwater Ecosystems"
     )
     ep_terr: ScopeSet | None = pyd.Field(
-        alias="ep-terr", description="Eutrophication Potential in Terrestrial Ecosystems"
+        alias="ep-terr", default=None, description="Eutrophication Potential in Terrestrial Ecosystems"
     )
     gwp_biogenic: ScopeSet | None = pyd.Field(
         alias="gwp-biogenic",
+        default=None,
         description="Net GWP from removals of atmospheric CO2 into biomass and  emissions of CO2 from biomass sources. "
         "To be counted as negative, CO2 removals must be closely linked to production in "
         "operational control (i.e. no purchased offsets), time (within three years of production) and "
@@ -140,6 +234,7 @@ class ImpactSet(BaseOpenEpdSchema):
     )
     gwp_luluc: ScopeSet | None = pyd.Field(
         alias="gwp-luluc",
+        default=None,
         description="Climate change effects related to land use and land use change, for example biogenic carbon "
         "exchanges resulting from deforestation or other soil activities (including soil carbon "
         "emissions). All related emissions for native forests are included under this category. "
@@ -147,10 +242,12 @@ class ImpactSet(BaseOpenEpdSchema):
     )
     gwp_nonCO2: ScopeSet | None = pyd.Field(
         alias="gwp-nonCO2",
+        default=None,
         description="GWP from non-CO2, non-fossil sources, such as livestock-sourced CH4 and agricultural N2O.",
     )
     gwp_fossil: ScopeSet | None = pyd.Field(
         alias="gwp-fossil",
+        default=None,
         description="Climate change effects due to greenhouse gas emissions originating from the oxidation or "
         "reduction of fossil fuels or materials containing fossil carbon. [Source: EN15804]",
     )
@@ -199,12 +296,14 @@ class LCIAMethod(StrEnum):
             return cls.UNKNOWN
 
 
-class Impacts(dict[LCIAMethod, ImpactSet]):
+class Impacts(pyd.BaseModel):
     """List of environmental impacts, compiled per one of the standard Impact Assessment methods."""
 
+    __root__: dict[LCIAMethod, ImpactSet]
+
     def set_unknown_lcia(self, impact_set: ImpactSet):
         """Set the impact set as an unknown LCIA method."""
-        self[LCIAMethod.UNKNOWN] = impact_set
+        self.__root__[LCIAMethod.UNKNOWN] = impact_set
 
     def set_impact_set(self, lcia_method: LCIAMethod | str | None, impact_set: ImpactSet):
         """
@@ -217,11 +316,25 @@ class Impacts(dict[LCIAMethod, ImpactSet]):
         else:
             if isinstance(lcia_method, str):
                 lcia_method = LCIAMethod.get_by_name(lcia_method)
-            self[lcia_method] = impact_set
+            self.__root__[lcia_method] = impact_set
+
+    def get_impact_set(
+        self, lcia_method: LCIAMethod | str | None, default_val: ImpactSet | None = None
+    ) -> ImpactSet | None:
+        """Return the impact set for the given LCIA method."""
+        if lcia_method is None:
+            return self.__root__.get(LCIAMethod.UNKNOWN, default_val)
+        if isinstance(lcia_method, str):
+            lcia_method = LCIAMethod.get_by_name(lcia_method)
+        return self.__root__.get(lcia_method, default_val)
 
     def available_methods(self) -> set[LCIAMethod]:
         """Return a list of available LCIA methods."""
-        return set(self.keys())
+        return set(self.__root__.keys())
+
+    def as_dict(self) -> dict[LCIAMethod, ImpactSet]:
+        """Return the impacts as a dictionary."""
+        return self.__root__
 
 
 class ResourceUseSet(BaseOpenEpdSchema):
@@ -230,47 +343,121 @@ class ResourceUseSet(BaseOpenEpdSchema):
     RPRec: ScopeSet | None = pyd.Field(
         description="Renewable primary resources used as energy carrier (fuel). "
         "First use bio-based materials used as an energy source. Hydropower, solar and wind power used "
-        "in the technosphere are also included in this indicator"
+        "in the technosphere are also included in this indicator",
+        default=None,
     )
     RPRm: ScopeSet | None = pyd.Field(
         description="Renewable primary resources with energy content used as material. "
-        "First use biobased materials used as materials (e.g. wood, hemp, etc.)."
-    )
-    rpre: ScopeSet | None = pyd.Field(description="Renewable primary energy resources as energy")
-    nrpre: ScopeSet | None = pyd.Field(description="Non-renewable primary resources as energy (fuel)")
-    nrprm: ScopeSet | None = pyd.Field(description="Non-renewable primary resources as material")
-    fw: ScopeSet | None = pyd.Field(description="Use of net fresh water")
-    sm: ScopeSet | None = pyd.Field(description="Use of secondary materials")
-    rsf: ScopeSet | None = pyd.Field(description="Use of renewable secondary materials")
-    nrsf: ScopeSet | None = pyd.Field(description="Use of non-renewable secondary fuels")
-    re: ScopeSet | None = pyd.Field(description="Renewable energy resources")
+        "First use biobased materials used as materials (e.g. wood, hemp, etc.).",
+        default=None,
+    )
+    rpre: ScopeSet | None = pyd.Field(
+        description="Renewable primary energy resources as energy",
+        default=None,
+    )
+    nrpre: ScopeSet | None = pyd.Field(
+        description="Non-renewable primary resources as energy (fuel)",
+        default=None,
+    )
+    nrprm: ScopeSet | None = pyd.Field(
+        description="Non-renewable primary resources as material",
+        default=None,
+    )
+    fw: ScopeSet | None = pyd.Field(
+        description="Use of net fresh water",
+        default=None,
+    )
+    sm: ScopeSet | None = pyd.Field(
+        description="Use of secondary materials",
+        default=None,
+    )
+    rsf: ScopeSet | None = pyd.Field(
+        description="Use of renewable secondary materials",
+        default=None,
+    )
+    nrsf: ScopeSet | None = pyd.Field(
+        description="Use of non-renewable secondary fuels",
+        default=None,
+    )
+    re: ScopeSet | None = pyd.Field(
+        description="Renewable energy resources",
+        default=None,
+    )
     pere: ScopeSet | None = pyd.Field(
-        description="Use of renewable primary energy excluding renewable primary energy resources used as raw materials"
+        description="Use of renewable primary energy excluding renewable primary energy resources used as raw materials",
+        default=None,
+    )
+    perm: ScopeSet | None = pyd.Field(
+        description="Use of renewable primary energy resources used as raw materials",
+        default=None,
+    )
+    pert: ScopeSet | None = pyd.Field(
+        description="Total use of renewable primary energy resources",
+        default=None,
     )
-    perm: ScopeSet | None = pyd.Field(description="Use of renewable primary energy resources used as raw materials")
-    pert: ScopeSet | None = pyd.Field(description="Total use of renewable primary energy resources")
     penre: ScopeSet | None = pyd.Field(
         description="Use of non-renewable primary energy excluding "
-        "non-renewable primary energy resources used as raw materials"
+        "non-renewable primary energy resources used as raw materials",
+        default=None,
     )
     penrm: ScopeSet | None = pyd.Field(
-        description="Use of non-renewable primary energy resources used as raw materials"
+        description="Use of non-renewable primary energy resources used as raw materials",
+        default=None,
+    )
+    penrt: ScopeSet | None = pyd.Field(
+        description="Total use of non-renewable primary energy resources",
+        default=None,
     )
-    penrt: ScopeSet | None = pyd.Field(description="Total use of non-renewable primary energy resources")
 
 
 class OutputFlowSet(BaseOpenEpdSchema):
     """A set of output flows, such as waste, emissions, etc."""
 
-    twd: ScopeSet | None = pyd.Field(description="Total waste disposed")
-    hwd: ScopeSet | None = pyd.Field(description="Hazardous waste disposed")
-    nhwd: ScopeSet | None = pyd.Field(description="Non-hazardous waste disposed")
-    rwd: ScopeSet | None = pyd.Field(description="Radioactive waste disposed")
-    hlrw: ScopeSet | None = pyd.Field(description="High level radioactive waste disposed")
-    illrw: ScopeSet | None = pyd.Field(description="Intermediate level radioactive waste disposed")
-    cru: ScopeSet | None = pyd.Field(description="Components for re-use")
-    mr: ScopeSet | None = pyd.Field(description="Recycled materials")
-    mfr: ScopeSet | None = pyd.Field(description="Materials for recycling")
-    mer: ScopeSet | None = pyd.Field(description="Materials for energy recovery")
-    ee: ScopeSet | None = pyd.Field(description="Exported energy")
-    eh: ScopeSet | None = pyd.Field(description="Exported heat")
+    twd: ScopeSet | None = pyd.Field(
+        description="Total waste disposed",
+        default=None,
+    )
+    hwd: ScopeSet | None = pyd.Field(
+        description="Hazardous waste disposed",
+        default=None,
+    )
+    nhwd: ScopeSet | None = pyd.Field(
+        description="Non-hazardous waste disposed",
+        default=None,
+    )
+    rwd: ScopeSet | None = pyd.Field(
+        description="Radioactive waste disposed",
+        default=None,
+    )
+    hlrw: ScopeSet | None = pyd.Field(
+        description="High level radioactive waste disposed",
+        default=None,
+    )
+    illrw: ScopeSet | None = pyd.Field(
+        description="Intermediate level radioactive waste disposed",
+        default=None,
+    )
+    cru: ScopeSet | None = pyd.Field(
+        description="Components for re-use",
+        default=None,
+    )
+    mr: ScopeSet | None = pyd.Field(
+        description="Recycled materials",
+        default=None,
+    )
+    mfr: ScopeSet | None = pyd.Field(
+        description="Materials for recycling",
+        default=None,
+    )
+    mer: ScopeSet | None = pyd.Field(
+        description="Materials for energy recovery",
+        default=None,
+    )
+    ee: ScopeSet | None = pyd.Field(
+        description="Exported energy",
+        default=None,
+    )
+    eh: ScopeSet | None = pyd.Field(
+        description="Exported heat",
+        default=None,
+    )

{openepd-0.10.0 → openepd-0.11.1}/src/openepd/model/org.py

@@ -22,62 +22,66 @@ from typing import Annotated, Optional
 import pydantic as pyd
 
 from openepd.model.base import BaseOpenEpdSchema
-from openepd.model.common import WithAltIdsMixin, WithAttachmentsMixin
-
-
-class Contact(BaseOpenEpdSchema):  # TODO: NEW Object, not in the spec
-    """Contact information of a person or organization."""
-
-    email: pyd.EmailStr | None = pyd.Field(description="Email", example="contact@c-change-labs.com", default=None)
-    phone: str | None = pyd.Field(description="Phone number", example="+15263327352", default=None)
-    website: pyd.AnyUrl | None = pyd.Field(
-        description="Url of the website", example="http://buildingtransparency.org", default=None
-    )
-    address: str | None = pyd.Field(description="Address", example="123 Main St, San Francisco, CA 94105", default=None)
+from openepd.model.common import Location, WithAltIdsMixin, WithAttachmentsMixin
 
 
 class Org(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
     """Represent an organization."""
 
-    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,
+        description="Common name for organization",
+        example="C Change Labs",
+        default=None,
     )
-    name: str = pyd.Field(max_length=200, description="Common name for organization", example="C Change Labs")
     alt_names: Annotated[list[str], pyd.conlist(pyd.constr(max_length=200), max_items=255)] | None = pyd.Field(
         description="List of other names for organization",
         example=["C-Change Labs", "C-Change Labs inc."],
         default=None,
     )
     # TODO: NEW field, not in the spec
-    contacts: Contact | None = pyd.Field(description="Contact information of the organization", default=None)
     owner: Optional["Org"] = pyd.Field(description="Organization that controls this organization", default=None)
     subsidiaries: Annotated[list[str], pyd.conlist(pyd.constr(max_length=200), max_items=255)] | None = pyd.Field(
         description="Organizations controlled by this organization",
         example=["cqd.io", "supplychaincarbonpricing.org"],
         default=None,
     )
+    hq_location: Location | None = pyd.Field(
+        default=None,
+        description="Location of a place of business, prefereably the corporate headquarters.",
+    )
 
 
 class Plant(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
     """Represent a manufacturing plant."""
 
     # TODO: Add proper validator
-    id: str = pyd.Field(
+    id: str | None = pyd.Field(
         description="Plus code (aka Open Location Code) of plant's location and "
         "owner's web domain joined with `.`(dot).",
         example="865P2W3V+3W.interface.com",
         alias="pluscode",
+        default=None,
     )
     owner: Org | None = pyd.Field(description="Organization that owns the plant", default=None)
-    name: str = pyd.Field(
-        max_length=200, description="Manufacturer's name for plant. Recommended < 40 chars", example="Dalton, GA"
+    name: str | None = pyd.Field(
+        max_length=200,
+        description="Manufacturer's name for plant. Recommended < 40 chars",
+        example="Dalton, GA",
+        default=None,
     )
-    address: str = pyd.Field(
+    address: str | None = pyd.Field(
         max_length=200,
+        default=None,
         description="Text address, preferably geocoded",
         example="1503 Orchard Hill Rd, LaGrange, GA 30240, United States",
     )
-    contact_email: pyd.EmailStr | None = pyd.Field(description="Email contact", example="info@interface.com")
+    contact_email: pyd.EmailStr | None = pyd.Field(
+        description="Email contact", example="info@interface.com", default=None
+    )
 
     class Config(BaseOpenEpdSchema.Config):
         allow_population_by_field_name = True

{openepd-0.10.0 → openepd-0.11.1}/src/openepd/model/pcr.py

@@ -30,44 +30,50 @@ from openepd.model.org import Org
 class Pcr(WithAttachmentsMixin, WithAltIdsMixin, BaseOpenEpdSchema):
     """Represent a PCR (Product Category Rules)."""
 
-    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,
     )
     issuer: Org | None = pyd.Field(description="Organization issuing this PCR", default=None)
     issuer_doc_id: str | None = pyd.Field(
         max_length=40,
+        default=None,
         description="Document ID or code created by issuer",
         example="c-PCR-003",
     )
     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)",
     )
     short_name: str | None = pyd.Field(
         max_length=40,
+        default=None,
         description="A shortened name without boilerplate text.",
         example="Concrete and Concrete Elements",
     )
-    version: pyd.PositiveInt = pyd.Field(
+    version: str | None = pyd.Field(
         description="Document version, as expressed in document.",
         example="1.0.2",
+        default=None,
     )
     date_of_issue: datetime.date | None = pyd.Field(
         example=datetime.date(day=11, month=2, year=2022),
+        default=None,
         description="First day on which the document is valid",
     )
     valid_until: datetime.date | None = pyd.Field(
         example=datetime.date(day=11, month=2, year=2024),
+        default=None,
         description="Last day on which the document is valid",
     )
     parent: Optional["Pcr"] = pyd.Field(
         description="The parent PCR, base PCR, `Part A` PCR",
         default=None,
     )
-    # TODO: why plural?
     product_classes: dict[str, str | list[str]] = pyd.Field(
         description="List of classifications, including Masterformat and UNSPC", default_factory=dict
     )