overture-schema-theme-buildings 0.1.1.dev0__tar.gz

overture_schema_theme_buildings-0.1.1.dev0/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: overture-schema-theme-buildings
+Version: 0.1.1.dev0
+Summary: Overture Maps buildings theme shared structures, building types, and building part types
+License-Expression: MIT
+Requires-Dist: overture-schema-common>=0.1.1
+Requires-Dist: overture-schema-system>=0.1.1
+Requires-Dist: pydantic>=2.13.0
+Maintainer: Overture Maps Schema Working Group
+Requires-Python: >=3.10
+Project-URL: Homepage, https://overturemaps.org
+Project-URL: Source, https://github.com/OvertureMaps/schema
+Project-URL: Issues, https://github.com/OvertureMaps/schema/issues
+Description-Content-Type: text/markdown
+
+# Overture Schema Buildings Theme
+
+Shared structures and validation logic for Overture Maps buildings theme.
+Contains common building types, classes, and shared validation patterns.

overture_schema_theme_buildings-0.1.1.dev0/README.md

@@ -0,0 +1,4 @@
+# Overture Schema Buildings Theme
+
+Shared structures and validation logic for Overture Maps buildings theme.
+Contains common building types, classes, and shared validation patterns.

overture_schema_theme_buildings-0.1.1.dev0/pyproject.toml

@@ -0,0 +1,83 @@
+[project]
+dependencies = [
+    "overture-schema-common>=0.1.1",
+    "overture-schema-system>=0.1.1",
+    "pydantic>=2.13.0",
+]
+description = "Overture Maps buildings theme shared structures, building types, and building part types"
+version = "0.1.1.dev0"
+license = "MIT"
+name = "overture-schema-theme-buildings"
+readme = "README.md"
+requires-python = ">=3.10"
+
+[[project.maintainers]]
+name = "Overture Maps Schema Working Group"
+
+[project.urls]
+Homepage = "https://overturemaps.org"
+Source = "https://github.com/OvertureMaps/schema"
+Issues = "https://github.com/OvertureMaps/schema/issues"
+
+[project.entry-points."overture.models"]
+building = "overture.schema.buildings:Building"
+building_part = "overture.schema.buildings:BuildingPart"
+
+[project.entry-points.pytest11]
+overture_baselines = "overture.schema.system.testing.plugin"
+
+[tool.uv.sources.overture-schema-common]
+workspace = true
+
+[tool.uv.sources.overture-schema-system]
+workspace = true
+
+[tool.uv.build-backend]
+module-name = "overture.schema.buildings"
+
+[build-system]
+requires = ["uv_build>=0.11.32,<0.13"]
+build-backend = "uv_build"
+
+[[examples.Building]]
+id = "148f35b1-7bc1-4180-9280-10d39b13883b"
+geometry = "POLYGON ((-176.6435004 -43.9938042, -176.6435738 -43.9937107, -176.6437726 -43.9937913, -176.6436992 -43.9938849, -176.6435004 -43.9938042))"
+version = 1
+has_parts = false
+is_underground = false
+theme = "buildings"
+type = "building"
+
+[examples.Building.bbox]
+xmin = -176.643798828125
+xmax = -176.64349365234375
+ymin = -43.9938850402832
+ymax = -43.993709564208984
+
+[[examples.Building.sources]]
+property = ""
+dataset = "OpenStreetMap"
+record_id = "w519166507@1"
+update_time = "2017-08-27T21:39:50.000Z"
+
+[[examples.BuildingPart]]
+id = "19412d64-51ac-3d6a-ac2f-8a8c8b91bb60"
+geometry = "POLYGON ((-73.2462509 -39.8108937, -73.2462755 -39.8109047, -73.246291 -39.8109182, -73.2463022 -39.8109382, -73.2463039 -39.810959, -73.2462962 -39.81098, -73.2462796 -39.8109977, -73.2462674 -39.8110052, -73.2462281 -39.8110153, -73.2461998 -39.811013, -73.2461743 -39.8110034, -73.2461566 -39.8109898, -73.246144 -39.8109702, -73.2461418 -39.8109427, -73.2461511 -39.8109221, -73.2461669 -39.8109066, -73.2461908 -39.8108947, -73.2462184 -39.8108898, -73.2462509 -39.8108937))"
+version = 0
+level = 3
+is_underground = false
+building_id = "bd663bd4-1844-4d7d-a400-114de051cf49"
+theme = "buildings"
+type = "building_part"
+
+[examples.BuildingPart.bbox]
+xmin = -73.24630737304688
+xmax = -73.24613952636719
+ymin = -39.81101608276367
+ymax = -39.81088638305664
+
+[[examples.BuildingPart.sources]]
+property = ""
+dataset = "OpenStreetMap"
+record_id = "w223076787@2"
+update_time = "2014-10-31T22:55:36.000Z"

overture_schema_theme_buildings-0.1.1.dev0/pyproject.toml.orig

@@ -0,0 +1,82 @@
+[project]
+maintainers = [
+    {name = "Overture Maps Schema Working Group"},
+]
+dependencies = [
+    "overture-schema-common>=0.1.1",
+    "overture-schema-system>=0.1.1",
+    "pydantic>=2.13.0",
+]
+description = "Overture Maps buildings theme shared structures, building types, and building part types"
+version = "0.1.1.dev0"
+license = "MIT"
+name = "overture-schema-theme-buildings"
+readme = "README.md"
+requires-python = ">=3.10"
+
+[project.urls]
+Homepage = "https://overturemaps.org"
+Source = "https://github.com/OvertureMaps/schema"
+Issues = "https://github.com/OvertureMaps/schema/issues"
+
+[tool.uv.sources]
+overture-schema-common = { workspace = true }
+overture-schema-system = { workspace = true }
+
+
+[build-system]
+requires = ["uv_build>=0.11.32,<0.13"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "overture.schema.buildings"
+
+[project.entry-points."overture.models"]
+building = "overture.schema.buildings:Building"
+building_part = "overture.schema.buildings:BuildingPart"
+
+[project.entry-points.pytest11]
+overture_baselines = "overture.schema.system.testing.plugin"
+
+[[examples.Building]]
+id = "148f35b1-7bc1-4180-9280-10d39b13883b"
+geometry = "POLYGON ((-176.6435004 -43.9938042, -176.6435738 -43.9937107, -176.6437726 -43.9937913, -176.6436992 -43.9938849, -176.6435004 -43.9938042))"
+version = 1
+has_parts = false
+is_underground = false
+theme = "buildings"
+type = "building"
+
+[examples.Building.bbox]
+xmin = -176.643798828125
+xmax = -176.64349365234375
+ymin = -43.9938850402832
+ymax = -43.993709564208984
+
+[[examples.Building.sources]]
+property = ""
+dataset = "OpenStreetMap"
+record_id = "w519166507@1"
+update_time = "2017-08-27T21:39:50.000Z"
+
+[[examples.BuildingPart]]
+id = "19412d64-51ac-3d6a-ac2f-8a8c8b91bb60"
+geometry = "POLYGON ((-73.2462509 -39.8108937, -73.2462755 -39.8109047, -73.246291 -39.8109182, -73.2463022 -39.8109382, -73.2463039 -39.810959, -73.2462962 -39.81098, -73.2462796 -39.8109977, -73.2462674 -39.8110052, -73.2462281 -39.8110153, -73.2461998 -39.811013, -73.2461743 -39.8110034, -73.2461566 -39.8109898, -73.246144 -39.8109702, -73.2461418 -39.8109427, -73.2461511 -39.8109221, -73.2461669 -39.8109066, -73.2461908 -39.8108947, -73.2462184 -39.8108898, -73.2462509 -39.8108937))"
+version = 0
+level = 3
+is_underground = false
+building_id = "bd663bd4-1844-4d7d-a400-114de051cf49"
+theme = "buildings"
+type = "building_part"
+
+[examples.BuildingPart.bbox]
+xmin = -73.24630737304688
+xmax = -73.24613952636719
+ymin = -39.81101608276367
+ymax = -39.81088638305664
+
+[[examples.BuildingPart.sources]]
+property = ""
+dataset = "OpenStreetMap"
+record_id = "w223076787@2"
+update_time = "2014-10-31T22:55:36.000Z"

overture_schema_theme_buildings-0.1.1.dev0/src/overture/schema/buildings/__init__.py

@@ -0,0 +1,29 @@
+"""Buildings theme.
+
+Human-made building structures, including building footprints and building parts with
+attributes like height, floors, and materials.
+"""
+
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)
+
+from ._common import (
+    Appearance,
+    FacadeMaterial,
+    RoofMaterial,
+    RoofOrientation,
+    RoofShape,
+)
+from .building import Building, BuildingClass, BuildingSubtype
+from .building_part import BuildingPart
+
+__all__ = [
+    "Appearance",
+    "Building",
+    "BuildingClass",
+    "BuildingPart",
+    "BuildingSubtype",
+    "FacadeMaterial",
+    "RoofMaterial",
+    "RoofOrientation",
+    "RoofShape",
+]

overture_schema_theme_buildings-0.1.1.dev0/src/overture/schema/buildings/_common.py

@@ -0,0 +1,204 @@
+import textwrap
+from enum import Enum
+from typing import Annotated
+
+from pydantic import BaseModel, Field
+
+from overture.schema.system.doc import DocumentedEnum
+from overture.schema.system.numeric import float64, int32
+from overture.schema.system.string import HexColor
+
+
+class FacadeMaterial(str, Enum):
+    """The outer surface material of building facade."""
+
+    BRICK = "brick"
+    CEMENT_BLOCK = "cement_block"
+    CLAY = "clay"
+    CONCRETE = "concrete"
+    GLASS = "glass"
+    METAL = "metal"
+    PLASTER = "plaster"
+    PLASTIC = "plastic"
+    STONE = "stone"
+    TIMBER_FRAMING = "timber_framing"
+    WOOD = "wood"
+
+
+class RoofMaterial(str, Enum):
+    """The outermost material of the roof."""
+
+    CONCRETE = "concrete"
+    COPPER = "copper"
+    ETERNIT = "eternit"
+    GLASS = "glass"
+    GRASS = "grass"
+    GRAVEL = "gravel"
+    METAL = "metal"
+    PLASTIC = "plastic"
+    ROOF_TILES = "roof_tiles"
+    SLATE = "slate"
+    SOLAR_PANELS = "solar_panels"
+    TAR_PAPER = "tar_paper"
+    THATCH = "thatch"
+    WOOD = "wood"
+
+
+class RoofShape(str, Enum):
+    """The shape of the roof."""
+
+    DOME = "dome"
+    FLAT = "flat"
+    GABLED = "gabled"
+    GAMBREL = "gambrel"
+    HALF_HIPPED = "half_hipped"
+    HIPPED = "hipped"
+    MANSARD = "mansard"
+    ONION = "onion"
+    PYRAMIDAL = "pyramidal"
+    ROUND = "round"
+    SALTBOX = "saltbox"
+    SAWTOOTH = "sawtooth"
+    SKILLION = "skillion"
+    SPHERICAL = "spherical"
+
+
+class RoofOrientation(str, DocumentedEnum):
+    """
+    Orientation of the roof shape relative to the footprint shape.
+
+    The members of this enumeration, `"across"` and `"along"`, are borrowed from the OpenStreetMap
+    `roof:orientation=*` tag and have the same meanings as they do in OSM.
+    """
+
+    ACROSS = (
+        "across",
+        "The roof ridge runs perpendicular to the longer of the two building edges, parallel to the shorter",
+    )
+    ALONG = (
+        "along",
+        "The roof ridge runs parallel to the longer of the two building edges",
+    )
+
+
+class Appearance(BaseModel):
+    """Physical and visual properties of a building, including dimensions, materials, and colors."""
+
+    # Optional
+
+    height: Annotated[
+        float64 | None,
+        Field(
+            gt=0,
+            description=textwrap.dedent("""
+                Height of the building or part in meters.
+
+                This is the distance from the lowest point to the highest point.
+            """).strip(),
+        ),
+    ] = None
+    is_underground: Annotated[
+        bool | None,
+        Field(
+            description=textwrap.dedent("""
+                Whether the entire building or part is completely below ground.
+
+                The underground flag is useful for display purposes. Buildings and building parts
+                that are entirely below ground can be styled differently or omitted from the
+                rendered image.
+
+                This flag is conceptually different from the `level` field, which indicates
+                relative z-ordering and, notably, can be negative even if the building is entirely
+                above-ground.
+            """).strip(),
+            strict=True,
+        ),
+    ] = None
+    num_floors: Annotated[
+        int32 | None,
+        Field(
+            gt=0,
+            description="Number of above-ground floors of the building or part.",
+        ),
+    ] = None
+    num_floors_underground: Annotated[
+        int32 | None,
+        Field(
+            gt=0,
+            description="Number of below-ground floors of the building or part.",
+        ),
+    ] = None
+    min_height: Annotated[
+        float64 | None,
+        Field(
+            description=textwrap.dedent("""
+                Altitude above ground where the bottom of the building or building part starts.
+
+                If present, this value indicates that the lowest part of the building or building
+                part starts is above ground level.
+            """).strip(),
+        ),
+    ] = None
+    min_floor: Annotated[
+        int32 | None,
+        Field(
+            gt=0,
+            description=textwrap.dedent("""
+                Start floor of this building or part.
+
+                If present, this value indicates that the building or part is "floating" and its
+                bottom-most floor is above ground level, usually because it is part of a larger
+                building in which some parts do reach down to ground level. An example is a building
+                that has an entry road or driveway at ground level into an interior courtyard, where
+                part of the building bridges above the entry road. This property may sometimes be
+                populated when `min_height` is missing and in these cases can be used as a proxy for
+                `min_height`.
+            """).strip(),
+        ),
+    ] = None
+    facade_color: Annotated[
+        HexColor | None,
+        Field(
+            description="Facade color in `#rgb` or `#rrggbb` hex notation",
+        ),
+    ] = None
+    facade_material: Annotated[
+        FacadeMaterial | None,
+        Field(description="Outer surface material of the facade"),
+    ] = None
+    roof_material: Annotated[
+        RoofMaterial | None, Field(description="Outer surface material of the roof")
+    ] = None
+    roof_shape: Annotated[RoofShape | None, Field(description="Shape of the roof")] = (
+        None
+    )
+    roof_direction: Annotated[
+        float64 | None,
+        Field(
+            ge=0,
+            lt=360,
+            description="Bearing of the roof ridge line in degrees",
+        ),
+    ] = None
+    roof_orientation: Annotated[
+        RoofOrientation | None,
+        Field(
+            description="""Orientation of the roof shape relative to the footprint shape""",
+        ),
+    ] = None
+    roof_color: Annotated[
+        HexColor | None,
+        Field(
+            description="The roof color in `#rgb` or `#rrggbb` hex notation",
+        ),
+    ] = None
+    roof_height: Annotated[
+        float64 | None,
+        Field(
+            description=textwrap.dedent("""
+                Height of the roof in meters.
+
+                This is the distance from the base of the roof to its highest point.
+            """).strip(),
+        ),
+    ] = None

overture_schema_theme_buildings-0.1.1.dev0/src/overture/schema/buildings/building.py

@@ -0,0 +1,202 @@
+"""
+The `Building` feature type model and supporting types.
+"""
+
+import textwrap
+from enum import Enum
+from typing import Annotated, Literal
+
+from pydantic import ConfigDict, Field
+
+from overture.schema.buildings._common import Appearance
+from overture.schema.common import OvertureFeature
+from overture.schema.common.level import Stacked
+from overture.schema.common.names import Named
+from overture.schema.system.geometric import (
+    Geometry,
+    GeometryType,
+    GeometryTypeConstraint,
+)
+
+
+class BuildingSubtype(str, Enum):
+    """
+    Broadest classification of the type and purpose of a building.
+
+    This broad classification can be refined by `BuildingClass`.
+    """
+
+    AGRICULTURAL = "agricultural"
+    CIVIC = "civic"
+    COMMERCIAL = "commercial"
+    EDUCATION = "education"
+    ENTERTAINMENT = "entertainment"
+    INDUSTRIAL = "industrial"
+    MEDICAL = "medical"
+    MILITARY = "military"
+    OUTBUILDING = "outbuilding"
+    RELIGIOUS = "religious"
+    RESIDENTIAL = "residential"
+    SERVICE = "service"
+    TRANSPORTATION = "transportation"
+
+
+class BuildingClass(str, Enum):
+    """
+    Further classification of the type and purpose of a building.
+
+    The building class adds detail to the broad classification of `BuildingSubtype`.
+    """
+
+    AGRICULTURAL = "agricultural"
+    ALLOTMENT_HOUSE = "allotment_house"
+    APARTMENTS = "apartments"
+    BARN = "barn"
+    BEACH_HUT = "beach_hut"
+    BOATHOUSE = "boathouse"
+    BRIDGE_STRUCTURE = "bridge_structure"
+    BUNGALOW = "bungalow"
+    BUNKER = "bunker"
+    CABIN = "cabin"
+    CARPORT = "carport"
+    CATHEDRAL = "cathedral"
+    CHAPEL = "chapel"
+    CHURCH = "church"
+    CIVIC = "civic"
+    COLLEGE = "college"
+    COMMERCIAL = "commercial"
+    COWSHED = "cowshed"
+    DETACHED = "detached"
+    DIGESTER = "digester"
+    DORMITORY = "dormitory"
+    DWELLING_HOUSE = "dwelling_house"
+    FACTORY = "factory"
+    FARM = "farm"
+    FARM_AUXILIARY = "farm_auxiliary"
+    FIRE_STATION = "fire_station"
+    GARAGE = "garage"
+    GARAGES = "garages"
+    GER = "ger"
+    GLASSHOUSE = "glasshouse"
+    GOVERNMENT = "government"
+    GRANDSTAND = "grandstand"
+    GREENHOUSE = "greenhouse"
+    GUARDHOUSE = "guardhouse"
+    HANGAR = "hangar"
+    HOSPITAL = "hospital"
+    HOTEL = "hotel"
+    HOUSE = "house"
+    HOUSEBOAT = "houseboat"
+    HUT = "hut"
+    INDUSTRIAL = "industrial"
+    KINDERGARTEN = "kindergarten"
+    KIOSK = "kiosk"
+    LIBRARY = "library"
+    MANUFACTURE = "manufacture"
+    MILITARY = "military"
+    MONASTERY = "monastery"
+    MOSQUE = "mosque"
+    OFFICE = "office"
+    OUTBUILDING = "outbuilding"
+    PARKING = "parking"
+    PAVILION = "pavilion"
+    POST_OFFICE = "post_office"
+    PRESBYTERY = "presbytery"
+    PUBLIC = "public"
+    RELIGIOUS = "religious"
+    RESIDENTIAL = "residential"
+    RETAIL = "retail"
+    ROOF = "roof"
+    SCHOOL = "school"
+    SEMI = "semi"
+    SEMIDETACHED_HOUSE = "semidetached_house"
+    SERVICE = "service"
+    SHED = "shed"
+    SHELTER = "shelter"
+    SHRINE = "shrine"
+    SILO = "silo"
+    SLURRY_TANK = "slurry_tank"
+    SPORTS_CENTRE = "sports_centre"
+    SPORTS_HALL = "sports_hall"
+    STABLE = "stable"
+    STADIUM = "stadium"
+    STATIC_CARAVAN = "static_caravan"
+    STILT_HOUSE = "stilt_house"
+    STORAGE_TANK = "storage_tank"
+    STY = "sty"
+    SUPERMARKET = "supermarket"
+    SYNAGOGUE = "synagogue"
+    TEMPLE = "temple"
+    TERRACE = "terrace"
+    TOILETS = "toilets"
+    TRAIN_STATION = "train_station"
+    TRANSFORMER_TOWER = "transformer_tower"
+    TRANSPORTATION = "transportation"
+    TRULLO = "trullo"
+    UNIVERSITY = "university"
+    WAREHOUSE = "warehouse"
+    WAYSIDE_SHRINE = "wayside_shrine"
+
+
+class Building(
+    OvertureFeature[Literal["buildings"], Literal["building"]],
+    Named,
+    Stacked,
+    Appearance,
+):
+    """
+    Buildings are man-made structures with roofs that exist permanently in one place.
+
+    A building's geometry represents the two-dimensional footprint of the building as viewed from
+    directly above, looking down. Fields such as `height` and `num_floors` allow the
+    three-dimensional shape to be approximated. Some buildings, identified by the `has_parts` field,
+    have associated `BuildingPart` features which can be used to generate a more representative 3D
+    model of the building.
+    """
+
+    model_config = ConfigDict(title="building")
+
+    # Overture Feature
+
+    geometry: Annotated[
+        Geometry,
+        GeometryTypeConstraint(GeometryType.POLYGON, GeometryType.MULTI_POLYGON),
+        Field(
+            description="""The building's footprint or roofprint (if traced from aerial/satellite imagery).""",
+        ),
+    ]
+
+    # Optional
+
+    subtype: Annotated[
+        BuildingSubtype | None,
+        Field(
+            description=textwrap.dedent("""
+                A broad classification of the current use and purpose of the building.
+
+                If the current use of the building no longer accords with the original built
+                purpose, the current use should be specified. For example, a building built as a
+                train station but later converted into a shopping mall would have the value
+                `"commercial"` rather than `"transportation"`.
+            """).strip()
+        ),
+    ] = None
+    class_: Annotated[
+        BuildingClass | None,
+        Field(
+            alias="class",
+            description=textwrap.dedent("""
+                A more specific classification of the current use and purpose of the building.
+
+                If the current use of the building no longer accords with the original built
+                purpose, the current use should be specified.
+            """).strip(),
+        ),
+    ] = None
+    has_parts: Annotated[
+        bool | None,
+        Field(
+            description="Whether the building has associated building part features",
+            strict=True,
+        ),
+    ] = None

overture_schema_theme_buildings-0.1.1.dev0/src/overture/schema/buildings/building_part.py

@@ -0,0 +1,56 @@
+"""
+The `BuildingPart` feature type model and supporting types.
+"""
+
+from typing import Annotated, Literal
+
+from pydantic import Field
+
+from overture.schema.buildings._common import Appearance
+from overture.schema.buildings.building import Building
+from overture.schema.common import OvertureFeature
+from overture.schema.common.level import Stacked
+from overture.schema.common.names import Named
+from overture.schema.system.geometric import (
+    Geometry,
+    GeometryType,
+    GeometryTypeConstraint,
+)
+from overture.schema.system.ref import Id, Reference, Relationship
+
+
+class BuildingPart(
+    OvertureFeature[Literal["buildings"], Literal["building_part"]],
+    Named,
+    Stacked,
+    Appearance,
+):
+    """
+    Building parts represent parts of larger building features. They allow buildings to be modeled
+    in rich detail suitable for creating realistic 3D models.
+
+    Every building part is associated with a parent `Building` feature via the `building_id` field.
+    In addition, a building part has a footprint geometry and may include additional details such as
+    its height, the number of floors, and the color and material of its facade and roof.
+
+    Building parts can float or be stacked on top of each other. The `min_height`, `min_floor`,
+    `height`, and `num_floors`, fields can be used to arrange the parts correctly along the
+    vertical dimension.
+    """
+
+    # Core
+    geometry: Annotated[
+        Geometry,
+        GeometryTypeConstraint(GeometryType.POLYGON, GeometryType.MULTI_POLYGON),
+        Field(
+            description="The footprint or roofprint of the building part.",
+        ),
+    ]
+
+    # Required
+
+    building_id: Annotated[
+        Id,
+        Field(description="The building to which this part belongs"),
+        Reference(Relationship.COMPOSITION, Building, role="part_of"),
+    ]