Skip to main content

create masks of geospatial regions for arbitrary grids

Project description

regionmask logo

create masks of geospatial regions for arbitrary grids

CI Status Code Coverage Badge Documentation Status PyPi Badge Anaconda-Server Badge zenodo DOI

When working with gridded data such as climate model output or reanalysis data it is often important to create regional averages, e.g., over countries, continents or regions defined in the literature. To do so we need to know for each grid point to which region it belongs to.

regionmask is a python package that:

  • can be used to create masks of (geo)spatial regions for arbitrary (longitude and latitude) grids. These masks indicate which region a gridpoint belongs to and can then be used to aggregate gridded data over the regions. The masks come in three variants:
    • 2D integer masks
    • 3D boolean masks
    • 3D approximate fractional masks
  • takes great care to create consistent masks for
    • region edges and interiors
    • overlapping regions
  • contains a number of defined regions, including:
    • countries
    • landmasks
    • regions used in the scientific literature
  • can plot figures of these regions
  • supports using arbitrary existing or user-defined region definitions:
    • regions defined as shapefiles can be accessed via geopandas
    • user-defined regions can be created via numpy or shapely

Documentation

Learn more about regionmask in its official documentation at https://regionmask.readthedocs.io

Get in touch

Dont hesitate to ask usage questions, report bugs, suggest features or view the source code on GitHub under regionmask/regionmask.

License

regionmask is published under a MIT license.

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

regionmask-0.13.0.tar.gz (311.1 kB view details)

Uploaded Source

Built Distribution

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

regionmask-0.13.0-py3-none-any.whl (72.3 kB view details)

Uploaded Python 3

File details

Details for the file regionmask-0.13.0.tar.gz.

File metadata

  • Download URL: regionmask-0.13.0.tar.gz
  • Upload date:
  • Size: 311.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for regionmask-0.13.0.tar.gz
Algorithm Hash digest
SHA256 56fd11986cd2f03bd3ac3ecb19399bff3e8cb79e151f7e33e18121735123abdf
MD5 740d8bc18acd7540ecb4b773d0b2d770
BLAKE2b-256 aa81cfc8d8531afde661d730c51b6252849a782989c7e122394987f0ff4e123e

See more details on using hashes here.

Provenance

The following attestation bundles were made for regionmask-0.13.0.tar.gz:

Publisher: pypi-release.yaml on regionmask/regionmask

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file regionmask-0.13.0-py3-none-any.whl.

File metadata

  • Download URL: regionmask-0.13.0-py3-none-any.whl
  • Upload date:
  • Size: 72.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for regionmask-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3e1b58260f047904aa225dd8692ef48d697afa73760c66a69a51ff41ab2acd26
MD5 8af604876cdbb78b58c66849353e6399
BLAKE2b-256 35a4fea8facd319ce29c27520406825e76c87fe07415cf34517e6e35cfb8f9fd

See more details on using hashes here.

Provenance

The following attestation bundles were made for regionmask-0.13.0-py3-none-any.whl:

Publisher: pypi-release.yaml on regionmask/regionmask

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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