create masks of geographical regions

regionmask is a Python module that:

• contains a number of defined regions, including: countries (from Natural Earth), and regions used in the scientific literature (the Giorgi regions [1] and the SREX regions [2]).
• can plot figures of these regions (tutorial) with matplotlib and cartopy
• can be used to create masks of the regions for arbitrary longitude and latitude grids with numpy (tutorial) and xarray (tutorial)
• arbitrary regions can be defined easily (tutorial)

Usage

Please have a look at the tutorials.

Contents

• Installation
  • Required dependencies
  • Optional dependencies
  • Instructions

Defined Regions

• Countries/ States (NaturalEarth)
  • Countries
  • US States
• ‘Scientific’ Regions
  • Giorgi Regions
  • SREX Regions

Tutorials

• Plotting
  • Plot all regions
  • Plot only a Subset of Regions
• Create numpy region mask
  • Create a mask with a different lon/ lat grid
• Create xarray region mask
• Create your own region
  • Use shapely Polygon

API Reference

• API reference
  • Top-level functions
  • Regions_cls
  • Region_cls
  • Private Functions

License

regionmask is published under a MIT license.

References

Region Definitions

[1]	Giorgi and Franciso, 2000

[2]	Seneviratne et al., 2012

Indices and tables

• Index
• Module Index
• Search Page