A powerful, format-agnostic, and community-driven Python library for analysing and visualising Earth science data
dkillick and pelson Use NetCDF variable's chunks on load (#3131)
Preserve NetCDF chunks on dataset load
Latest commit 718f604 Sep 13, 2018

README.md

Iris

Iris is a powerful, format-agnostic, community-driven Python library for analysing and visualising Earth science data

conda-forge downloads Latest version Commits since last release # contributors Travis-CI zenodo


Table of contents

Overview

Iris implements a data model based on the CF conventions giving you a powerful, format-agnostic interface for working with your data. It excels when working with multi-dimensional Earth Science data, where tabular representations become unwieldy and inefficient.

CF Standard names, units, and coordinate metadata are built into Iris, giving you a rich and expressive interface for maintaining an accurate representation of your data. Its treatment of data and associated metadata as first-class objects includes:

  • a visualisation interface based on matplotlib and cartopy,
  • unit conversion,
  • subsetting and extraction,
  • merge and concatenate,
  • aggregations and reductions (including min, max, mean and weighted averages),
  • interpolation and regridding (including nearest-neighbor, linear and area-weighted), and
  • operator overloads (+, -, *, /, etc.)

A number of file formats are recognised by Iris, including CF-compliant NetCDF, GRIB, and PP, and it has a plugin architecture to allow other formats to be added seamlessly.

Building upon NumPy and dask, Iris scales from efficient single-machine workflows right through to multi-core clusters and HPC. Interoperability with packages from the wider scientific Python ecosystem comes from Iris' use of standard NumPy/dask arrays as its underlying data storage.

Documentation

The documentation for Iris is available at https://scitools.org.uk/iris/docs/latest, including a user guide, example code, and gallery.

Installation

The easiest way to install Iris is with conda:

conda install -c conda-forge iris

Detailed instructions, including information on installing from source, are available in INSTALL.

Copyright and licence

Iris may be freely distributed, modified and used commercially under the terms of its GNU LGPLv3 license.

(C) British Crown Copyright 2010 - 2018, Met Office