Skip to main content

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.

Metadata

Release files for regionmask 0.13.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for regionmask 0.13.0
File Size Uploaded Provenance Actions
regionmask-0.13.0.tar.gz 311.1 kB With provenance Details for regionmask-0.13.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for regionmask 0.13.0
File Interpreter ABI Platform Actions
regionmask-0.13.0-py3-none-any.whl Python 3 none any Details for regionmask-0.13.0-py3-none-any.whl

Total release size: 383.4 kB

Release files / regionmask-0.13.0.tar.gz

Download URL regionmask-0.13.0.tar.gz
Size 311.1 kB
Tags Source
SHA-256 checksum
How to use checksums
56fd11986cd2f03bd3ac3ecb19399bff3e8cb79e151f7e33e18121735123abdf
BLAKE2b-256 checksum
How to use checksums
aa81cfc8d8531afde661d730c51b6252849a782989c7e122394987f0ff4e123e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 3, 2024.

Transparency log

Release files / regionmask-0.13.0-py3-none-any.whl

Download URL regionmask-0.13.0-py3-none-any.whl
Size 72.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3e1b58260f047904aa225dd8692ef48d697afa73760c66a69a51ff41ab2acd26
BLAKE2b-256 checksum
How to use checksums
35a4fea8facd319ce29c27520406825e76c87fe07415cf34517e6e35cfb8f9fd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 3, 2024.

Transparency log

Security for regionmask 0.13.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for regionmask-0.13.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 3, 2024.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page