Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hrodmn committed Dec 24, 2024
1 parent 8293918 commit 3963e5c
Show file tree
Hide file tree
Showing 11 changed files with 2,745 additions and 681 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,13 @@
- Extra fields:
- `overture:theme`: Overture Maps theme
- `overture:type`: Overture Maps feature type
- `overture:release`: Overture Maps release
- [Browse the example in human-readable form](https://radiantearth.github.io/stac-browser/#/external/raw.githubusercontent.com/stactools-packages/overture-maps/main/examples/catalog.json)
- [Browse a notebook demonstrating the example item and collection](https://github.com/stactools-packages/overture-maps/tree/main/docs/example.ipynb)

This package can be used to generate STAC metadata for the Overture Maps dataset.
Collections are separated by the Overture 'Themes': Addresses, Base, Buildings, Divisions, Places, and Transportation.

Items represent individual parquet files in object storage and each one will correspond to a single partition for a theme (`overture:theme`), feature type (`overture:type:`), and release (`overture:release`).
Items represent individual parquet files in object storage and each one will correspond to a single partition for a theme (`overture:theme`), feature type (`overture:type:`), and release (`version`).

Ideally we would include some collection-level assets for the entire `theme/type` table connections, but that will come in a later version of this package.

Expand Down Expand Up @@ -61,7 +60,7 @@ You can create an item with just the `href` for the parquet asset:

```bash
stac overturemaps create-item \
https://oveturemapswestus2.blob.core.windows.net/release/2024-12-18.0/theme=addresses/type=address/part-00000-de803747-d78d-4060-b3da-da6dcd5dbab8-c000.zstd.parquet \
https://overturemapswestus2.blob.core.windows.net/release/2024-12-18.0/theme=addresses/type=address/part-00000-de803747-d78d-4060-b3da-da6dcd5dbab8-c000.zstd.parquet \
item.json
```

Expand Down
2,867 changes: 2,196 additions & 671 deletions docs/example.ipynb

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion examples/overture-maps-addresses/collection.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"type": "Collection",
"id": "overture-maps-addresses",
"stac_version": "1.0.0",
"description": "## Overture Maps - addresses\n\nThis collection contains items for the addresses theme.\n\n_Note: This theme is currently in Alpha and we anticipate significant changes over the next several releases. We invite the Overture community to test the addresses schema and data and offer feedback via the [data](https://github.com/OvertureMaps/data/issues) and [schema](https://github.com/OvertureMaps/schema/issues) repos._\n\nOverture maintains nearly 394 million address point entities. Data in the address theme is derived from over 60 sources, many distributed by [OpenAddresses](https://openaddresses.io/) and [AddressForAll](https://www.addressforall.org/en/), but also includes open data from the [City of New York](https://data.cityofnewyork.us/City-Government/NYC-Address-Points/g6pj-hd8k) and the [U.S. Department of Transportation](https://www.transportation.gov/gis/national-address-database).\n\nFor licensing information, please see the [Attribution and Licensing page](https://docs.overturemaps.org/attribution/).\n\nAddress data can be used for a variety of purposes, which can include:\n\n- **Mapping**: Addresses may be displayed on the map for reference purposes.\n- **Geocoding**: Addresses are a primary component of high-accuracy geocoding services (i.e. converting text for an address to a complete address with a location).\n- **Conflation**: Addresses can be used to conflate to other data themes (e.g. places, buildings) where appropriate for mapping or other use cases (e.g. refining search).\n- **Standardization**: Parsing an input address into address components based on an existing schema or address model.\n- **Normalization**: Adhering to standard and consistent forms of address components.\n- **Validation and Verification**: Confirming an address exists within a known list of addresses.\n\nSee the official [guide](https://docs.overturemaps.org/guides/addresses/) for tips on querying and analyzing this dataset.\n\n## Data assets\n\nThe features are provided as a set of [geoparquet](https://github.com/opengeospatial/geoparquet) datasets. The data are partitioned by\n\n1. Theme\n2. Type\n\nEach `(Theme, Type)` pair will have one or more geoparquet files, depending on the density of the of the features in that area.\n\nNote that older items in this dataset (version 2024.02.15-alpha.0 and earlier) are **not** spatially partitioned. We recommend using data with a release of 2023-03-12-alpha.0 or newer. The release is part of the URL for each parquet file and is captured in the STAC metadata for each item (see below).\n\n## STAC metadata\n\nThe `overture:type` property can be used to filter items to a specific feature type, and the `overture:release` property can be used to filter items to a specific release.\n\n## About Overture Maps\n\nOverture is a collaborative open-data initiative led by software developers, data experts,cartographic engineers, and product managers from dozens of Overture Maps Foundation member companies. Since our launch in December 2022, Overture members have been working toward a shared vision: to create reliable, user-friendly, and interoperable open map data that supports both current and future map products. We envision a world where shared, open base layers drive collaboration and innovation across industries and communities.\n\nFor more information, visit the [Overture Maps Foundation](https://overturemaps.org/).\n\n",
"description": "## Overture Maps - addresses\n\nThis collection contains items for the addresses theme.\n\n_Note: This theme is currently in Alpha and we anticipate significant changes over the next several releases. We invite the Overture community to test the addresses schema and data and offer feedback via the [data](https://github.com/OvertureMaps/data/issues) and [schema](https://github.com/OvertureMaps/schema/issues) repos._\n\nOverture maintains nearly 394 million address point entities. Data in the address theme is derived from over 60 sources, many distributed by [OpenAddresses](https://openaddresses.io/) and [AddressForAll](https://www.addressforall.org/en/), but also includes open data from the [City of New York](https://data.cityofnewyork.us/City-Government/NYC-Address-Points/g6pj-hd8k) and the [U.S. Department of Transportation](https://www.transportation.gov/gis/national-address-database).\n\nFor licensing information, please see the [Attribution and Licensing page](https://docs.overturemaps.org/attribution/).\n\nAddress data can be used for a variety of purposes, which can include:\n\n- **Mapping**: Addresses may be displayed on the map for reference purposes.\n- **Geocoding**: Addresses are a primary component of high-accuracy geocoding services (i.e. converting text for an address to a complete address with a location).\n- **Conflation**: Addresses can be used to conflate to other data themes (e.g. places, buildings) where appropriate for mapping or other use cases (e.g. refining search).\n- **Standardization**: Parsing an input address into address components based on an existing schema or address model.\n- **Normalization**: Adhering to standard and consistent forms of address components.\n- **Validation and Verification**: Confirming an address exists within a known list of addresses.\n\nSee the official [guide](https://docs.overturemaps.org/guides/addresses/) for tips on querying and analyzing this dataset.\n\n## Data assets\n\nThe features are provided as a set of [geoparquet](https://github.com/opengeospatial/geoparquet) datasets. The data are partitioned by\n\n1. Theme\n2. Type\n\nEach `(Theme, Type)` pair will have one or more geoparquet files, depending on the density of the of the features in that area.\n\nNote that older items in this dataset (version 2024.02.15-alpha.0 and earlier) are **not** spatially partitioned. We recommend using data with a release of 2023-03-12-alpha.0 or newer. The release is part of the URL for each parquet file and is captured in the STAC metadata for each item (see below).\n\n## STAC metadata\n\nThe `overture:type` property can be used to filter items to a specific feature type, and the `version` property can be used to filter items to a specific release.\n\n## About Overture Maps\n\nOverture is a collaborative open-data initiative led by software developers, data experts,cartographic engineers, and product managers from dozens of Overture Maps Foundation member companies. Since our launch in December 2022, Overture members have been working toward a shared vision: to create reliable, user-friendly, and interoperable open map data that supports both current and future map products. We envision a world where shared, open base layers drive collaboration and innovation across industries and communities.\n\nFor more information, visit the [Overture Maps Foundation](https://overturemaps.org/).\n\n",
"links": [
{
"rel": "root",
Expand Down
2 changes: 1 addition & 1 deletion examples/overture-maps-base/collection.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"type": "Collection",
"id": "overture-maps-base",
"stac_version": "1.0.0",
"description": "## Overture Maps - base\n\nThis collection contains items for the base theme.\n\nThe Overture Maps base theme provides the land, water, and infrastructure features that are necessary to render a complete basemap. The majority of these features come from OpenStreetMap. We classify OSM features into *type*, *subtype*, and *class* based on their tags. The land and ocean polygons are derived from the [Daylight Coastlines](https://daylightmap.org/coastlines.html). The theme includes five feature types:\n\n- **`infrastructure`**: Infrastructure features such as communication towers and lines, piers, and bridges from OpenStreetMap.\n- **`land`**: physical representations of land surfaces derived from the inverse of OSM Coastlines; translates natural tags from OpenStreetMap.\n- **`land_cover`**: derived from [ESA WorldCover](https://esa-worldcover.org/en), high-resolution optical Earth observation data.\n- **`land_use`**: classifications of the human use of a section of land; translates landuse tag from OpenStreetMap.\n- **`water`**: physical representations of inland and ocean marine surfaces; translates natural and waterway tags from OpenStreetMap.\n\nSee the official [guide](https://docs.overturemaps.org/guides/base/) for tips on querying and analyzing this dataset.\n\n## Data assets\n\nThe features are provided as a set of [geoparquet](https://github.com/opengeospatial/geoparquet) datasets. The data are partitioned by\n\n1. Theme\n2. Type\n\nEach `(Theme, Type)` pair will have one or more geoparquet files, depending on the density of the of the features in that area.\n\nNote that older items in this dataset (version 2024.02.15-alpha.0 and earlier) are **not** spatially partitioned. We recommend using data with a release of 2023-03-12-alpha.0 or newer. The release is part of the URL for each parquet file and is captured in the STAC metadata for each item (see below).\n\n## STAC metadata\n\nThe `overture:type` property can be used to filter items to a specific feature type, and the `overture:release` property can be used to filter items to a specific release.\n\n## About Overture Maps\n\nOverture is a collaborative open-data initiative led by software developers, data experts,cartographic engineers, and product managers from dozens of Overture Maps Foundation member companies. Since our launch in December 2022, Overture members have been working toward a shared vision: to create reliable, user-friendly, and interoperable open map data that supports both current and future map products. We envision a world where shared, open base layers drive collaboration and innovation across industries and communities.\n\nFor more information, visit the [Overture Maps Foundation](https://overturemaps.org/).\n\n",
"description": "## Overture Maps - base\n\nThis collection contains items for the base theme.\n\nThe Overture Maps base theme provides the land, water, and infrastructure features that are necessary to render a complete basemap. The majority of these features come from OpenStreetMap. We classify OSM features into *type*, *subtype*, and *class* based on their tags. The land and ocean polygons are derived from the [Daylight Coastlines](https://daylightmap.org/coastlines.html). The theme includes five feature types:\n\n- **`infrastructure`**: Infrastructure features such as communication towers and lines, piers, and bridges from OpenStreetMap.\n- **`land`**: physical representations of land surfaces derived from the inverse of OSM Coastlines; translates natural tags from OpenStreetMap.\n- **`land_cover`**: derived from [ESA WorldCover](https://esa-worldcover.org/en), high-resolution optical Earth observation data.\n- **`land_use`**: classifications of the human use of a section of land; translates landuse tag from OpenStreetMap.\n- **`water`**: physical representations of inland and ocean marine surfaces; translates natural and waterway tags from OpenStreetMap.\n\nSee the official [guide](https://docs.overturemaps.org/guides/base/) for tips on querying and analyzing this dataset.\n\n## Data assets\n\nThe features are provided as a set of [geoparquet](https://github.com/opengeospatial/geoparquet) datasets. The data are partitioned by\n\n1. Theme\n2. Type\n\nEach `(Theme, Type)` pair will have one or more geoparquet files, depending on the density of the of the features in that area.\n\nNote that older items in this dataset (version 2024.02.15-alpha.0 and earlier) are **not** spatially partitioned. We recommend using data with a release of 2023-03-12-alpha.0 or newer. The release is part of the URL for each parquet file and is captured in the STAC metadata for each item (see below).\n\n## STAC metadata\n\nThe `overture:type` property can be used to filter items to a specific feature type, and the `version` property can be used to filter items to a specific release.\n\n## About Overture Maps\n\nOverture is a collaborative open-data initiative led by software developers, data experts,cartographic engineers, and product managers from dozens of Overture Maps Foundation member companies. Since our launch in December 2022, Overture members have been working toward a shared vision: to create reliable, user-friendly, and interoperable open map data that supports both current and future map products. We envision a world where shared, open base layers drive collaboration and innovation across industries and communities.\n\nFor more information, visit the [Overture Maps Foundation](https://overturemaps.org/).\n\n",
"links": [
{
"rel": "root",
Expand Down
2 changes: 1 addition & 1 deletion examples/overture-maps-buildings/collection.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"type": "Collection",
"id": "overture-maps-buildings",
"stac_version": "1.0.0",
"description": "## Overture Maps - buildings\n\nThis collection contains items for the buildings theme.\n\nThe Overture Maps buildings theme describes human-made structures with roofs or interior spaces that are permanently or semi-permanently in one place (source: [OSM building definition](https://wiki.openstreetmap.org/wiki/Key:building)). The theme includes two feature types:\n\n- **`building`**: The most basic form of a building feature. The geometry is expected to be the most outer footprint—roofprint if traced from satellite/aerial imagery—of a building. Buildings have a boolean attribute `has_parts` that describe whether there are any associated building parts.\n- **`building_part`**: A single part of a building. Building parts may share the same properties as buildings. A building part is associated with a parent building via a `building_id`.\n\nSee the official [guide](https://docs.overturemaps.org/guides/buildings/) for tips on querying and analyzing this dataset.\n\n## Data assets\n\nThe features are provided as a set of [geoparquet](https://github.com/opengeospatial/geoparquet) datasets. The data are partitioned by\n\n1. Theme\n2. Type\n\nEach `(Theme, Type)` pair will have one or more geoparquet files, depending on the density of the of the features in that area.\n\nNote that older items in this dataset (version 2024.02.15-alpha.0 and earlier) are **not** spatially partitioned. We recommend using data with a release of 2023-03-12-alpha.0 or newer. The release is part of the URL for each parquet file and is captured in the STAC metadata for each item (see below).\n\n## STAC metadata\n\nThe `overture:type` property can be used to filter items to a specific feature type, and the `overture:release` property can be used to filter items to a specific release.\n\n## About Overture Maps\n\nOverture is a collaborative open-data initiative led by software developers, data experts,cartographic engineers, and product managers from dozens of Overture Maps Foundation member companies. Since our launch in December 2022, Overture members have been working toward a shared vision: to create reliable, user-friendly, and interoperable open map data that supports both current and future map products. We envision a world where shared, open base layers drive collaboration and innovation across industries and communities.\n\nFor more information, visit the [Overture Maps Foundation](https://overturemaps.org/).\n\n",
"description": "## Overture Maps - buildings\n\nThis collection contains items for the buildings theme.\n\nThe Overture Maps buildings theme describes human-made structures with roofs or interior spaces that are permanently or semi-permanently in one place (source: [OSM building definition](https://wiki.openstreetmap.org/wiki/Key:building)). The theme includes two feature types:\n\n- **`building`**: The most basic form of a building feature. The geometry is expected to be the most outer footprint—roofprint if traced from satellite/aerial imagery—of a building. Buildings have a boolean attribute `has_parts` that describe whether there are any associated building parts.\n- **`building_part`**: A single part of a building. Building parts may share the same properties as buildings. A building part is associated with a parent building via a `building_id`.\n\nSee the official [guide](https://docs.overturemaps.org/guides/buildings/) for tips on querying and analyzing this dataset.\n\n## Data assets\n\nThe features are provided as a set of [geoparquet](https://github.com/opengeospatial/geoparquet) datasets. The data are partitioned by\n\n1. Theme\n2. Type\n\nEach `(Theme, Type)` pair will have one or more geoparquet files, depending on the density of the of the features in that area.\n\nNote that older items in this dataset (version 2024.02.15-alpha.0 and earlier) are **not** spatially partitioned. We recommend using data with a release of 2023-03-12-alpha.0 or newer. The release is part of the URL for each parquet file and is captured in the STAC metadata for each item (see below).\n\n## STAC metadata\n\nThe `overture:type` property can be used to filter items to a specific feature type, and the `version` property can be used to filter items to a specific release.\n\n## About Overture Maps\n\nOverture is a collaborative open-data initiative led by software developers, data experts,cartographic engineers, and product managers from dozens of Overture Maps Foundation member companies. Since our launch in December 2022, Overture members have been working toward a shared vision: to create reliable, user-friendly, and interoperable open map data that supports both current and future map products. We envision a world where shared, open base layers drive collaboration and innovation across industries and communities.\n\nFor more information, visit the [Overture Maps Foundation](https://overturemaps.org/).\n\n",
"links": [
{
"rel": "root",
Expand Down
Loading

0 comments on commit 3963e5c

Please sign in to comment.