openepd 6.12.0__py3-none-any.whl → 6.13.0__py3-none-any.whl

openepd/m49/geo_converter.py

@@ -0,0 +1,178 @@
+#
+#  Copyright 2025 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.
+#
+from typing import Collection
+
+from openepd.m49.const import (
+    COUNTRY_VERBOSE_NAME_TO_M49,
+    ISO3166_ALPHA2_TO_M49,
+    M49_TO_COUNTRY_VERBOSE_NAME,
+    M49_TO_ISO3166_ALPHA2,
+    M49_TO_REGION_VERBOSE_NAME,
+    OPENEPD_SPECIAL_REGIONS,
+    REGION_VERBOSE_NAME_TO_M49,
+)
+
+
+def iso_to_m49(regions: Collection[str]) -> set[str]:
+    """
+    Convert ISO3166 alpha2 country codes to M49 region codes.
+
+    :param regions: List of ISO3166 alpha2 country codes (e.g., ["US", "CA", "MX"])
+    :return: Set of M49 region codes (e.g., {"840", "124", "484"})
+    :raises ValueError: If a country code is not found in M49 region codes.
+    """
+
+    if not regions:
+        return set()
+
+    result = set()
+    for code in regions:
+        m49_code = ISO3166_ALPHA2_TO_M49.get(code.upper())
+        if m49_code:
+            result.add(m49_code)
+        else:
+            raise ValueError(f"Country code '{code}' not found in M49 region codes.")
+
+    return result
+
+
+def m49_to_iso(regions: Collection[str]) -> set[str]:
+    """
+    Convert M49 region codes to ISO3166 alpha2 country codes.
+
+    :param regions: List of M49 region codes (e.g., ["840", "124", "484"])
+    :return: Set of ISO3166 alpha2 country codes (e.g., {"US", "CA", "MX"})
+    :raises ValueError: If a region code is not found in ISO3166.
+    """
+
+    if not regions:
+        return set()
+
+    result = set()
+    for code in regions:
+        iso_code = M49_TO_ISO3166_ALPHA2.get(code.upper())
+        if iso_code:
+            result.add(iso_code)
+        else:
+            raise ValueError(f"Region code '{code}' not found in ISO3166.")
+
+    return result
+
+
+def region_and_country_names_to_m49(regions: Collection[str]) -> set[str]:
+    """
+    Convert user-friendly region and country names to M49 region codes.
+
+    :param regions: List of user-friendly region and country names (e.g., ["Europe",
+        "North America", "Austria", "Germany"])
+    :return: Set of M49 region codes (e.g., {"150", "003", "040", "276"})
+    :raises ValueError: If a region or country name is not found in M49 region codes.
+    """
+
+    if not regions:
+        return set()
+
+    result = set()
+    for name in regions:
+        m49_code = REGION_VERBOSE_NAME_TO_M49.get(name.title()) or COUNTRY_VERBOSE_NAME_TO_M49.get(name.title())
+        if not m49_code:
+            raise ValueError(f"Region or country name '{name}' not found in M49 region codes.")
+        result.add(m49_code)
+
+    return result
+
+
+def m49_to_region_and_country_names(regions: Collection[str]) -> set[str]:
+    """
+    Convert M49 region codes to user-friendly region names and country names.
+
+    :param regions: List of M49 region codes (e.g., ["150", "003", "040", "276"])
+    :return: Set of user-friendly region and country names (e.g., {"Europe", "North America", "Austria", "Germany"})
+    :raises ValueError: If a region code is not found in M49 region codes.
+    """
+
+    if not regions:
+        return set()
+
+    result = set()
+    for code in regions:
+        if code not in M49_TO_REGION_VERBOSE_NAME and code not in M49_TO_COUNTRY_VERBOSE_NAME:
+            raise ValueError(f"Region code '{code}' not found in M49 region codes.")
+
+        name = M49_TO_REGION_VERBOSE_NAME.get(code) or M49_TO_COUNTRY_VERBOSE_NAME.get(code, code)
+        result.add(name)
+    return result
+
+
+def openepd_to_m49(regions: Collection[str]) -> set[str]:
+    """
+    Convert OpenEPD geography definitions to pure M49 region codes.
+
+    :param regions: list of OpenEPD geography definitions including letter codes and aliases
+        like "EU27" or "NAFTA" (e.g., ["EU27", "NAFTA"], ["US", "CA, MX"])
+    :return: Set of M49 region codes (e.g., {"040", "056", "100", "191", "196", "203", "208", "233", "246", "250",
+        "276", "300", "348", "372", "380", "428", "440", "442", "470", "528", "616", "620", "642", "703", "705", "724",
+        "752", "840", "124", "484"}, {"840", "124", "484"})
+    :raises ValueError: If a region or country name is not found in ISO3166 or OpenEPD special regions.
+    """
+
+    if not regions:
+        return set()
+
+    result = set()
+    for region in regions:
+        if region in OPENEPD_SPECIAL_REGIONS:
+            result.update(OPENEPD_SPECIAL_REGIONS[region].m49_codes)
+        else:
+            m49_code = ISO3166_ALPHA2_TO_M49.get(region.upper())
+            if m49_code:
+                result.add(m49_code)
+            else:
+                raise ValueError(f"Region '{region}' not found in ISO3166 or OpenEPD special regions.")
+    return result
+
+
+def m49_to_openepd(regions: list[str]) -> set[str]:
+    """
+    Convert M49 region codes to OpenEPD geography definitions.
+
+    :param regions: List of M49 region codes (e.g., ["040", "056", "100", "191", "196", "203", "208", "233", "246",
+        "250", "276", "300", "348", "372", "380", "428", "440", "442", "470", "528", "616", "620", "642", "703", "705",
+        "724", "752", "840", "124", "484"], ["840", "124", "484"], ["040", "056", "100"])
+    :return: Set of OpenEPD geography definitions including letter codes and aliases
+        like "EU27" or "NAFTA" (e.g., {"EU27", "NAFTA"}, {"NAFTA"}, {"AT", "BE", "BG"})
+    :raises ValueError: If a region code is not found in ISO3166 or OpenEPD special regions.
+    """
+
+    if not regions:
+        return set()
+
+    result = set()
+    remaining_codes = set(regions)
+    for special_region, special_region_data in OPENEPD_SPECIAL_REGIONS.items():
+        special_region_codes = set(special_region_data.m49_codes)
+        if special_region_codes.issubset(remaining_codes):
+            result.add(special_region)
+            remaining_codes -= special_region_codes
+
+    for code in remaining_codes:
+        iso_code = M49_TO_ISO3166_ALPHA2.get(code)
+        if iso_code:
+            result.add(iso_code)
+        else:
+            raise ValueError(f"Region code '{code}' not found in ISO3166 or OpenEPD special regions.")
+
+    return result

openepd/model/specs/range/furnishings.py

@@ -236,12 +236,12 @@ class FurnishingsRangeV1(BaseOpenEpdHierarchicalSpec):
         default=None, title="Functional Storage Volume", description=""
     )
     functional_seating_capacity: RangeInt | None = pyd.Field(
-        default=1,
+        default=None,
         title="Functional Seating Capacity",
         description="Intended number of individuals the product seats. This value is used in calculating impact per functional unit.",
     )
     installation_waste_factor: RangeRatioFloat | None = pyd.Field(
-        default=0.01,
+        default=None,
         title="Installation Waste Factor",
         description="Typical increase in impacts to account for installation waste.",
     )

openepd/model/specs/singular/furnishings.py

@@ -175,13 +175,13 @@ class FurnishingsV1(BaseOpenEpdHierarchicalSpec):
         example="1 m3",
     )
     functional_seating_capacity: pyd.NonNegativeInt | None = pyd.Field(
-        default=1,
+        default=None,
         title="Functional Seating Capacity",
         description="Intended number of individuals the product seats. This value is used in calculating impact per functional unit.",
         example=1,
     )
     installation_waste_factor: RatioFloat | None = pyd.Field(
-        default=0.01,
+        default=None,
         title="Installation Waste Factor",
         description="Typical increase in impacts to account for installation waste.",
         example=0.01,

{openepd-6.12.0.dist-info → openepd-6.13.0.dist-info}/METADATA

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

{openepd-6.12.0.dist-info → openepd-6.13.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 openepd/__init__.py,sha256=fhxfEyEurLvSfvQci-vb3njzl_lvhcLXiZrecCOaMU8,794
-openepd/__version__.py,sha256=4igRnJ4prO4O--ghi78JXsgSz4xobA4SHm1zlb0MpHU,639
+openepd/__version__.py,sha256=a5hKzjDC_6ktbu65wQ9YE2NrU-x54HWyTkooE0uHe-g,639
 openepd/api/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/api/average_dataset/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/api/average_dataset/generic_estimate_sync_api.py,sha256=KHCmSKMOJTQct6vhdhAatAENoouStc_yVRza5AFNoIo,7953
@@ -32,6 +32,9 @@ openepd/bundle/writer.py,sha256=gHK1D-F-td2C18QFWerg666JUTLaGUkTUSQURJi9o74,8136
 openepd/compat/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/compat/compat_functional_validators.py,sha256=aWg3a80fqT8zjN0S260N-Ad2WFKAaB8ByN7ArBW3NMA,834
 openepd/compat/pydantic.py,sha256=dNwPXK1X5xq9sdkd0kcbKQAUIter1GAfcxXOl6hmITQ,1146
+openepd/m49/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
+openepd/m49/const.py,sha256=O31VJ5_sR4GAOvJnFsi3An2YMaMa96H7XBqaQ0kNwnw,31734
+openepd/m49/geo_converter.py,sha256=mRamQTVwd35kwn5-23N3E8cxqpYG7l9eW787SJYM7nw,6515
 openepd/model/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/model/base.py,sha256=1GeaEDn-ppy94GaOaZI1y6Yew_0eBBho1COaxfzzLCw,9834
 openepd/model/category.py,sha256=reeOVRDuZPYU77EMwG0K5VjnK2H9yOGxT0PJXXqrjEk,1639
@@ -67,7 +70,7 @@ openepd/model/specs/range/electrical_transmission_and_distribution_equipment.py,
 openepd/model/specs/range/electricity.py,sha256=yn_S25C_tZqseb8hiJ1yiHszu2mQ49FOFWWCqNpOBY0,997
 openepd/model/specs/range/finishes.py,sha256=oCaPVYJja1KYxwEzTHCl7HtxQ2mokzeyahjyP33zHSg,21291
 openepd/model/specs/range/fire_and_smoke_protection.py,sha256=u5veICQznf-woYlh49S_IbvPA23CLWEy7Ngvic2FIpw,3337
-openepd/model/specs/range/furnishings.py,sha256=Es3rPvWT1opiMtyp7PdzKLe74pFRgs1jkROU51AoNDA,6528
+openepd/model/specs/range/furnishings.py,sha256=7r9albaHmuf0ttqkSQ6elJcSzgFgOHSrwAfhEpJMm5k,6531
 openepd/model/specs/range/grouting.py,sha256=BQPxH6BvlXpdhLEZBui9zTuY93K_9syjoa6rdnF8GGY,1095
 openepd/model/specs/range/manufacturing_inputs.py,sha256=xzgkNz7yG8cp715hxS0LtJX9nfJ5RQR8GxlD2bAduwE,5574
 openepd/model/specs/range/masonry.py,sha256=IyjQMb8Mx3tpJlHIIam0OrMkFsJXKvc0WXRLRBupozY,2867
@@ -106,7 +109,7 @@ openepd/model/specs/singular/electrical_transmission_and_distribution_equipment.
 openepd/model/specs/singular/electricity.py,sha256=f1cJ9eklNUf97khCIZiT5-z8V_TbOcvH2me_1UTQVrE,823
 openepd/model/specs/singular/finishes.py,sha256=bAlNZiUP-HwePaJyC1D4j2fpv0xnMp3V5mhtAs9iaxQ,22571
 openepd/model/specs/singular/fire_and_smoke_protection.py,sha256=1uyEGdMAsboYORHvSFN1wftRVAps_UJ1Ep3Dk9arT3s,3058
-openepd/model/specs/singular/furnishings.py,sha256=rogO5XZl1341xPnVMQ1CSIcLiKbh66ZqmXXXR_em0MA,5600
+openepd/model/specs/singular/furnishings.py,sha256=6V6Dc4xph8PcIQhuuLFyFGL4w2Yh_ByEKCNvQfUkxZQ,5603
 openepd/model/specs/singular/grouting.py,sha256=pg2tX3W7a2TQ3z_eyFYGlBJY3WEwn6JlZyqM3PQIJcU,934
 openepd/model/specs/singular/manufacturing_inputs.py,sha256=9WSDOVN0mUqvFXqWf82lkpHi-XRQSMcEpe9bweegwhU,5093
 openepd/model/specs/singular/masonry.py,sha256=f6nph-gscAmVeJ60bG-ebto5kz0fgh0LY27n0VutGFA,3165
@@ -136,7 +139,7 @@ openepd/model/validation/quantity.py,sha256=vfSe-3DGQf84bCp_sMIU0ZPAA1wIilodpTjL
 openepd/model/versioning.py,sha256=cm3LaAUODnbbu3W3pC6baJzxKusTQ1kZH-PwwScCj3c,4473
 openepd/patch_pydantic.py,sha256=LVqDMKn723VYYf_V-RgTLxIb1xiUtYOfPYCQP6-7RoM,4122
 openepd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openepd-6.12.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-6.12.0.dist-info/METADATA,sha256=S3MymGCa7n1SY6ew2g3Z4LRvO0z462bqjgdBTQRuym8,9039
-openepd-6.12.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-openepd-6.12.0.dist-info/RECORD,,
+openepd-6.13.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openepd-6.13.0.dist-info/METADATA,sha256=ta3TH3-bGEhZt0NaiXcVVkEtbLuKY2YyX8ZwNhMv2Fo,9039
+openepd-6.13.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+openepd-6.13.0.dist-info/RECORD,,