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.12.1.tar.gz (317.1 kB view details)

Uploaded Source

Built Distribution

regionmask-0.12.1-py3-none-any.whl (73.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: regionmask-0.12.1.tar.gz
  • Upload date:
  • Size: 317.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for regionmask-0.12.1.tar.gz
Algorithm Hash digest
SHA256 7ef1e70c6ebab7bfc6a80e13f6fe771945b8b6a31b7f8980fc88c8b8505bb854
MD5 2a7eac1a48825f047d83f25606d69e72
BLAKE2b-256 7bfefaec77648332b6f71736c4ae0966f2a54c858bce89cc9f17b81b664de625

See more details on using hashes here.

File details

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

File metadata

  • Download URL: regionmask-0.12.1-py3-none-any.whl
  • Upload date:
  • Size: 73.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for regionmask-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9a56ec4ecde00eff76b50022c97980bd0d95959afc35723f358fba1a372131e1
MD5 7bdbf0f2642f6f828fe99acec2947fe9
BLAKE2b-256 d4f36380fd7f2765f95a79bec867716c8bb1dffa6b017152ee49a098b74deed0

See more details on using hashes here.

Supported by

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