Skip to main content

A Python package for downloading and processing Overture Maps geospatial data with configurable bounding box extraction and data management.

Project description

Overture Maps Geoparquet Package

PyPI License Python

Overview

The Overture Maps Geoparquet Package is a Python library designed for downloading and processing geospatial data from Overture Maps in a user-friendly way. This package allows users to specify an Area of Interest (AOI) through a GeoJSON file, automatically extract its bounding box, and download relevant geospatial data types, such as buildings, land use, and infrastructure, in GeoParquet format.

Features

  • Automated Bounding Box Extraction: Parses a GeoJSON file and extracts the bounding box for easy area targeting.
  • Flexible Data Downloading: Downloads various data types (e.g., buildings, infrastructure) in GeoParquet format for efficient storage and analysis.
  • Easy Command-Line and Script Integration: The package provides a simple interface, allowing users to start the download process with a single function call.
  • Data Organization: Downloads are organized into folders based on the AOI and data type, keeping data management straightforward.

Installation

To install the package, use pip:

pip install overture_maps_geoparquet_package

Usage

Here’s a quick guide on how to use the package:

  1. Prepare a GeoJSON File

    Create a GeoJSON file that defines your area of interest (AOI). Save it in your project directory (e.g., my_area.json).

  2. Run the Download Function

    Import and call download_overture_data, passing the path to your GeoJSON file:

    from overture_maps_geoparquet_package import download_overture_data
    
    # Download geospatial data for the specified area
    download_overture_data("my_area.json")
    

    This will:

    • Extract the bounding box from your GeoJSON file.
    • Download geospatial data (e.g., buildings, land use, infrastructure) for the AOI.
    • Save the data in organized folders within the current directory.

Example

from overture_maps_geoparquet_package import download_overture_data

# Specify the path to your GeoJSON file
geojson_path = "path/to/your_area.json"

# Start the download process
download_overture_data(geojson_path)

This code will automatically download the specified data types in GeoParquet format, organized by type.

Custom Output Directory

The download_overture_data function allows users to specify a custom directory to store downloaded data. By default, the data will be saved in a directory named overture_data in the current working directory. However, if you want to store the data in a different location, you can pass the desired path as a second argument.

from overture_maps_geoparquet_package import download_overture_data

# Specify the path to your GeoJSON file
geojson_path = "path/to/your_area.json"

# Start the download process with a custom directory
download_overture_data(geojson_path, "custom/data/directory")

In this example:

  • Default behavior: If no second argument is provided, the data will be saved in overture_data.
  • Custom directory: If you specify a custom directory (e.g., "custom_data_directory"), the data will be stored there instead.

This flexibility allows you to organize downloaded data more effectively, especially if you work with multiple Areas of Interest (AOIs) or projects.

Data Types Supported

The following data types are downloaded for each AOI:

  • address
  • building
  • division
  • infrastructure
  • land use
  • water
  • And more...

Each type is saved in a folder structure organized by data category.

Project Structure

The project follows a standard layout:

overture_maps_geoparquet_package/
├── json/                 # Stores GeoJSON files
├── overture_data/        # Downloaded data, organized by AOI and type
├── src/                  # Source code for the package
├── tests/                # Unit tests
├── README.md             # Project documentation
├── pyproject.toml        # Project configuration
└── requirements.txt      # Dependency management

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests for feature requests, bug fixes, or improvements.

  1. Fork the repository
  2. Create a new branch (git checkout -b feature-branch)
  3. Make your changes
  4. Submit a pull request

License

This project is licensed under the GPL-3.0 License. See the LICENSE file for more details.

Contact

For questions, please contact ediakatos@mapaction.org.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

overture_maps_geoparquet_package-0.1.2.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file overture_maps_geoparquet_package-0.1.2.tar.gz.

File metadata

File hashes

Hashes for overture_maps_geoparquet_package-0.1.2.tar.gz
Algorithm Hash digest
SHA256 630056e90db4ea16953de76e91ee7669efaa1eaf8d132fa6beadf98ec900ad5a
MD5 53e9532bf8739d4cf73a6692ca9070b7
BLAKE2b-256 88acf14292a0c1c02fbc021a0c98d436ca725746e1e9b531fddccd98a9e9fb63

See more details on using hashes here.

File details

Details for the file overture_maps_geoparquet_package-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for overture_maps_geoparquet_package-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a24a8324411faa25f5322ef0d62cf0c25a66d3334de273a77b98b9c49f520ba4
MD5 2b20a2dd78a492c339b439cc90d062f5
BLAKE2b-256 415f180c3e5e0735216e88d04b102082159d484d65564a5568d5b0c83d6e2cb5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page