User Manual

Hint

If you are new to Iris: check out Get Started first.

Welcome to the Iris User Manual!

This is designed as a searchable index of all our user documentation. Try the Topic and Diataxis filters below to find the information you need today. Alternatively, you can use the sidebar to navigate by section.

Tip

• User Manual: a searchable index of all user documentation.

• User Guide: a linear narrative introduction to Iris’ data model and functionality.

All

All topic: data_model topic: slice_combine topic: load_save topic: lazy_data topic: plotting topic: maths_stats topic: regrid topic: customisation topic: troubleshooting topic: experimental topic: interoperability topic: mesh topic: about

All

Dataless Cubes	Read about Iris' support for Cubes with no data payload.
Iris Data Structures	Read about the core Iris data model.
Iris' Philosophy	Read about how and why Iris is made the way it is.
Iris ❤️ Xarray	Read about the similarities and differences between Iris and Xarray.
Lenient Cube Maths	Read about the options for handling metadata differences during Cube maths.
Lenient Metadata	Read about the options for handling metadata differences between Cubes.
The Mesh Data Model	Read about how Iris represents unstructured mesh data.
Mesh Partner Packages	Read about Python packages you can use alongside Iris to work with mesh data.
Metadata	Read about metadata in the Iris data model e.g. names, units.
Missing Data Handling in Iris	Read about how Iris handles missing/masked data during Cube load/save/modification.
NetCDF I/O Handling in Iris	Read about how Iris loads and saves NetCDF files.
Real and Lazy Data	Read about how Iris defers data loading from disk.
Iris Handling of PP and Fieldsfiles	Read about how Iris represents Met Office UM PP and Fieldsfiles data.
Reviewing the Iris User Experience	Read about how we plan to review and improve the user experience of Iris.
Which Regridder to Use	Read about the different regridders available in Iris.
Why Iris	Read about the Iris Python package and why you might want to use it.
Applying a Filter to a Time-Series	How to apply a low pass filter to an Iris Cube via rolling_window().
Colouring Anomaly Data With Logarithmic Scaling	How to visualise values using a logarithmic scale.
Deriving the Coriolis Frequency Over the Globe	How to create your own Cube from computed data and visualise it.
Cross Section Plots	How to visualise cross-sections of multi-dimensional Cubes.
Calculating a Custom Statistic	How to define and use a custom aggregation operation, including visualisation.
Loading a Cube From a Custom File Format	How to visualise data from a file Iris does not natively support.
Quickplot of a 2D Cube on a Map	A demonstration of basic iris.quickplot use.
Test Data Showing Inset Plots	How to create inset plots within a main plot.
Multi-Line Temperature Profile Plot	How to plot multiple lines on a single plot with a legend.
Example of a Polar Stereographic Plot	A demonstration of plotting data defined on an alternative map projection.
Fitting a Polynomial	How to compute and plot a polynomial fit to 1D data in an Iris cube.
Plotting in Different Projections	How to overlay data from two different map projections and add graphics.
Rotated Pole Mapping	How to visualise data via different methods and coordinate systems.
Zonal Mean Diagram of Air Temperature	How to use aligned plots to visualise collapsed dimensional statistics.
Global Average Annual Temperature Plot	How to spatially constrain data, compute statistics and visualise a comparison.
Global Average Annual Temperature Maps	How to produce comparative maps of two files with a shared colour bar.
Ionosphere Space Weather	How to mask out values below a threshold in a plot.
Deriving Exner Pressure and Air Temperature	How to use Iris arithmetic to derive phenomena from existing cubes and plot them.
Hovmoller Diagram of Monthly Surface Temperature	How to collapse and plot Cubes to create a Hovmoller diagram.
Seasonal Ensemble Model Plots	How to use Iris in a complex real-world analysis scenario.
Plotting Wind Direction Using Barbs	How to use Iris to derive and plot wind barbs.
Plotting Wind Direction Using Quiver	How to use Iris to plot wind quivers.
Oceanographic Profiles and T-S Diagrams	How to use Iris' for visualising oceanographic profile data, including scatter plotting.
Load a Time Series of Data From the NEMO Model	How to concatenate data from multiple NEMO files.
Tri-Polar Grid Projected Plotting	How to visualise data defined on a tri-polar grid using different map projections.
Filtering Warnings	How to customise Iris' warnings to only see those you need.
Installing	How to install the Iris Python package.
Converting Other Mesh Formats	How to convert other mesh formats into Iris' Mesh Data Model.
Working with Mesh Data	How to perform common Iris operations on unstructured mesh data.
Navigating a Cube	How to access the properties of a Cube.
Plugins	How to create and use plugins to extend Iris' functionality.
Controlling Merge and Concatenate	A lesson in fine-grain control of combining Iris Cubes.
Cube Maths	A lesson in mathematical operations on Iris Cubes.
Cube Statistics	A lesson in statistical operations on Iris Cubes.
Dask Bags and Greedy Parallelism	A real-world demonstration of using Dask Bags with Iris, including hazards to watch out for.
Parallelising a Loop of Multiple Calls to a Third Party Library	A real-world demonstration of parallelising function calls with Dask.
Speeding up Converting PP Files to NetCDF	A real-world demonstration of tuning Dask and Iris for better performance when saving data.
Cube Interpolation and Regridding	A lesson in Iris' interpolation and regridding functionality.
Loading Iris Cubes	A lesson in how Iris loading works.
Merge and Concatenate	A lesson in the various ways to combine Cubes along different dimensional axes.
Plotting a Cube	A lesson on visualising Iris Cubes using Cartopy and Matplotlib.
Loading From and Saving To S3 Buckets	A lesson on using s3-fuse with Iris to load/save data from/to S3 buckets.
Saving Iris Cubes	A lesson on writing Iris Cubes to file in various formats.
Subsetting a Cube	A lesson on subsetting Iris Cubes by extraction, masking, and iteration.
iris	API reference
iris.analysis	API reference
iris.analysis.calculus	API reference
iris.analysis.cartography	API reference
iris.analysis.geometry	API reference
iris.analysis.maths	API reference
iris.analysis.stats	API reference
iris.analysis.trajectory	API reference
iris.aux_factory	API reference
iris.common	API reference
iris.common.lenient	API reference
iris.common.metadata	API reference
iris.common.mixin	API reference
iris.common.resolve	API reference
iris.config	API reference
iris.coord_categorisation	API reference
iris.coord_systems	API reference
iris.coords	API reference
iris.cube	API reference
iris.exceptions	API reference
iris.experimental	API reference
iris.experimental.animate	API reference
iris.experimental.geovista	API reference
iris.experimental.regrid	API reference
iris.experimental.regrid_conservative	API reference
iris.experimental.representation	API reference
iris.experimental.stratify	API reference
iris.experimental.ugrid	API reference
iris.fileformats	API reference
iris.fileformats.abf	API reference
iris.fileformats.cf	API reference
iris.fileformats.dot	API reference
iris.fileformats.name	API reference
iris.fileformats.name_loaders	API reference
iris.fileformats.netcdf	API reference
iris.fileformats.netcdf.loader	API reference
iris.fileformats.netcdf.saver	API reference
iris.fileformats.netcdf.ugrid_load	API reference
iris.fileformats.nimrod	API reference
iris.fileformats.nimrod_load_rules	API reference
iris.fileformats.pp	API reference
iris.fileformats.pp_load_rules	API reference
iris.fileformats.pp_save_rules	API reference
iris.fileformats.rules	API reference
iris.fileformats.um	API reference
iris.fileformats.um_cf_map	API reference
iris.io	API reference
iris.io.format_picker	API reference
iris.iterate	API reference
iris.loading	API reference
iris.mesh	API reference
iris.mesh.components	API reference
iris.mesh.utils	API reference
iris.palette	API reference
iris.pandas	API reference
iris.plot	API reference
iris.quickplot	API reference
iris.symbols	API reference
iris.time	API reference
iris.util	API reference
iris.warnings	API reference
Citing Iris	Information on the correct way to cite the Iris Python package.
Glossary	Information on common terms used within Iris documentation.
Phrasebook	Information on terminology differences between Iris and similar packages.

Tutorial

Guided lessons for understanding a topic.

(Supports study, via action)

Controlling Merge and Concatenate	A lesson in fine-grain control of combining Iris Cubes.
Cube Maths	A lesson in mathematical operations on Iris Cubes.
Cube Statistics	A lesson in statistical operations on Iris Cubes.
Dask Bags and Greedy Parallelism	A real-world demonstration of using Dask Bags with Iris, including hazards to watch out for.
Parallelising a Loop of Multiple Calls to a Third Party Library	A real-world demonstration of parallelising function calls with Dask.
Speeding up Converting PP Files to NetCDF	A real-world demonstration of tuning Dask and Iris for better performance when saving data.
Cube Interpolation and Regridding	A lesson in Iris' interpolation and regridding functionality.
Loading Iris Cubes	A lesson in how Iris loading works.
Merge and Concatenate	A lesson in the various ways to combine Cubes along different dimensional axes.
Plotting a Cube	A lesson on visualising Iris Cubes using Cartopy and Matplotlib.
Loading From and Saving To S3 Buckets	A lesson on using s3-fuse with Iris to load/save data from/to S3 buckets.
Saving Iris Cubes	A lesson on writing Iris Cubes to file in various formats.
Subsetting a Cube	A lesson on subsetting Iris Cubes by extraction, masking, and iteration.

Explanation

In-depth discussion for understanding concepts.

(Supports study, via theory)

Dataless Cubes	Read about Iris' support for Cubes with no data payload.
Iris Data Structures	Read about the core Iris data model.
Iris' Philosophy	Read about how and why Iris is made the way it is.
Iris ❤️ Xarray	Read about the similarities and differences between Iris and Xarray.
Lenient Cube Maths	Read about the options for handling metadata differences during Cube maths.
Lenient Metadata	Read about the options for handling metadata differences between Cubes.
The Mesh Data Model	Read about how Iris represents unstructured mesh data.
Mesh Partner Packages	Read about Python packages you can use alongside Iris to work with mesh data.
Metadata	Read about metadata in the Iris data model e.g. names, units.
Missing Data Handling in Iris	Read about how Iris handles missing/masked data during Cube load/save/modification.
NetCDF I/O Handling in Iris	Read about how Iris loads and saves NetCDF files.
Real and Lazy Data	Read about how Iris defers data loading from disk.
Iris Handling of PP and Fieldsfiles	Read about how Iris represents Met Office UM PP and Fieldsfiles data.
Reviewing the Iris User Experience	Read about how we plan to review and improve the user experience of Iris.
Which Regridder to Use	Read about the different regridders available in Iris.
Why Iris	Read about the Iris Python package and why you might want to use it.

How-to

Step by step instructions for achieving a specific goal.

(Supports work, via action)

Applying a Filter to a Time-Series	How to apply a low pass filter to an Iris Cube via rolling_window().
Colouring Anomaly Data With Logarithmic Scaling	How to visualise values using a logarithmic scale.
Deriving the Coriolis Frequency Over the Globe	How to create your own Cube from computed data and visualise it.
Cross Section Plots	How to visualise cross-sections of multi-dimensional Cubes.
Calculating a Custom Statistic	How to define and use a custom aggregation operation, including visualisation.
Loading a Cube From a Custom File Format	How to visualise data from a file Iris does not natively support.
Quickplot of a 2D Cube on a Map	A demonstration of basic iris.quickplot use.
Test Data Showing Inset Plots	How to create inset plots within a main plot.
Multi-Line Temperature Profile Plot	How to plot multiple lines on a single plot with a legend.
Example of a Polar Stereographic Plot	A demonstration of plotting data defined on an alternative map projection.
Fitting a Polynomial	How to compute and plot a polynomial fit to 1D data in an Iris cube.
Plotting in Different Projections	How to overlay data from two different map projections and add graphics.
Rotated Pole Mapping	How to visualise data via different methods and coordinate systems.
Zonal Mean Diagram of Air Temperature	How to use aligned plots to visualise collapsed dimensional statistics.
Global Average Annual Temperature Plot	How to spatially constrain data, compute statistics and visualise a comparison.
Global Average Annual Temperature Maps	How to produce comparative maps of two files with a shared colour bar.
Ionosphere Space Weather	How to mask out values below a threshold in a plot.
Deriving Exner Pressure and Air Temperature	How to use Iris arithmetic to derive phenomena from existing cubes and plot them.
Hovmoller Diagram of Monthly Surface Temperature	How to collapse and plot Cubes to create a Hovmoller diagram.
Seasonal Ensemble Model Plots	How to use Iris in a complex real-world analysis scenario.
Plotting Wind Direction Using Barbs	How to use Iris to derive and plot wind barbs.
Plotting Wind Direction Using Quiver	How to use Iris to plot wind quivers.
Oceanographic Profiles and T-S Diagrams	How to use Iris' for visualising oceanographic profile data, including scatter plotting.
Load a Time Series of Data From the NEMO Model	How to concatenate data from multiple NEMO files.
Tri-Polar Grid Projected Plotting	How to visualise data defined on a tri-polar grid using different map projections.
Filtering Warnings	How to customise Iris' warnings to only see those you need.
Installing	How to install the Iris Python package.
Converting Other Mesh Formats	How to convert other mesh formats into Iris' Mesh Data Model.
Working with Mesh Data	How to perform common Iris operations on unstructured mesh data.
Navigating a Cube	How to access the properties of a Cube.
Plugins	How to create and use plugins to extend Iris' functionality.

Reference

Concise information to look up when needed.

(Supports work, via theory)

iris	API reference
iris.analysis	API reference
iris.analysis.calculus	API reference
iris.analysis.cartography	API reference
iris.analysis.geometry	API reference
iris.analysis.maths	API reference
iris.analysis.stats	API reference
iris.analysis.trajectory	API reference
iris.aux_factory	API reference
iris.common	API reference
iris.common.lenient	API reference
iris.common.metadata	API reference
iris.common.mixin	API reference
iris.common.resolve	API reference
iris.config	API reference
iris.coord_categorisation	API reference
iris.coord_systems	API reference
iris.coords	API reference
iris.cube	API reference
iris.exceptions	API reference
iris.experimental	API reference
iris.experimental.animate	API reference
iris.experimental.geovista	API reference
iris.experimental.regrid	API reference
iris.experimental.regrid_conservative	API reference
iris.experimental.representation	API reference
iris.experimental.stratify	API reference
iris.experimental.ugrid	API reference
iris.fileformats	API reference
iris.fileformats.abf	API reference
iris.fileformats.cf	API reference
iris.fileformats.dot	API reference
iris.fileformats.name	API reference
iris.fileformats.name_loaders	API reference
iris.fileformats.netcdf	API reference
iris.fileformats.netcdf.loader	API reference
iris.fileformats.netcdf.saver	API reference
iris.fileformats.netcdf.ugrid_load	API reference
iris.fileformats.nimrod	API reference
iris.fileformats.nimrod_load_rules	API reference
iris.fileformats.pp	API reference
iris.fileformats.pp_load_rules	API reference
iris.fileformats.pp_save_rules	API reference
iris.fileformats.rules	API reference
iris.fileformats.um	API reference
iris.fileformats.um_cf_map	API reference
iris.io	API reference
iris.io.format_picker	API reference
iris.iterate	API reference
iris.loading	API reference
iris.mesh	API reference
iris.mesh.components	API reference
iris.mesh.utils	API reference
iris.palette	API reference
iris.pandas	API reference
iris.plot	API reference
iris.quickplot	API reference
iris.symbols	API reference
iris.time	API reference
iris.util	API reference
iris.warnings	API reference
Citing Iris	Information on the correct way to cite the Iris Python package.
Glossary	Information on common terms used within Iris documentation.
Phrasebook	Information on terminology differences between Iris and similar packages.

By Topic

topic: data_model

Pages about the Cube class and its associated components such as Coord and MeshXY.

All topic: data_model topic: slice_combine topic: load_save topic: lazy_data topic: plotting topic: maths_stats topic: regrid topic: customisation topic: troubleshooting topic: experimental topic: interoperability topic: mesh topic: about

All

Dataless Cubes	Read about Iris' support for Cubes with no data payload.
Iris Data Structures	Read about the core Iris data model.
Lenient Cube Maths	Read about the options for handling metadata differences during Cube maths.
Lenient Metadata	Read about the options for handling metadata differences between Cubes.
The Mesh Data Model	Read about how Iris represents unstructured mesh data.
Metadata	Read about metadata in the Iris data model e.g. names, units.
Missing Data Handling in Iris	Read about how Iris handles missing/masked data during Cube load/save/modification.
Deriving the Coriolis Frequency Over the Globe	How to create your own Cube from computed data and visualise it.
Fitting a Polynomial	How to compute and plot a polynomial fit to 1D data in an Iris cube.
Seasonal Ensemble Model Plots	How to use Iris in a complex real-world analysis scenario.
Load a Time Series of Data From the NEMO Model	How to concatenate data from multiple NEMO files.
Navigating a Cube	How to access the properties of a Cube.
iris	API reference
iris.aux_factory	API reference
iris.common	API reference
iris.common.lenient	API reference
iris.common.metadata	API reference
iris.common.mixin	API reference
iris.common.resolve	API reference
iris.coord_categorisation	API reference
iris.coord_systems	API reference
iris.coords	API reference
iris.cube	API reference
iris.experimental.representation	API reference
iris.experimental.ugrid	API reference
iris.mesh	API reference
iris.mesh.components	API reference
iris.mesh.utils	API reference
iris.time	API reference
iris.util	API reference
Glossary	Information on common terms used within Iris documentation.

Tutorial

Guided lessons for understanding a topic.

(Supports study, via action)

No pages for this filter.

Explanation

In-depth discussion for understanding concepts.

(Supports study, via theory)

Dataless Cubes	Read about Iris' support for Cubes with no data payload.
Iris Data Structures	Read about the core Iris data model.
Lenient Cube Maths	Read about the options for handling metadata differences during Cube maths.
Lenient Metadata	Read about the options for handling metadata differences between Cubes.
The Mesh Data Model	Read about how Iris represents unstructured mesh data.
Metadata	Read about metadata in the Iris data model e.g. names, units.
Missing Data Handling in Iris	Read about how Iris handles missing/masked data during Cube load/save/modification.

How-to

Step by step instructions for achieving a specific goal.

(Supports work, via action)

Deriving the Coriolis Frequency Over the Globe	How to create your own Cube from computed data and visualise it.
Fitting a Polynomial	How to compute and plot a polynomial fit to 1D data in an Iris cube.
Seasonal Ensemble Model Plots	How to use Iris in a complex real-world analysis scenario.
Load a Time Series of Data From the NEMO Model	How to concatenate data from multiple NEMO files.
Navigating a Cube	How to access the properties of a Cube.

Reference

Concise information to look up when needed.

(Supports work, via theory)

iris	API reference
iris.aux_factory	API reference
iris.common	API reference
iris.common.lenient	API reference
iris.common.metadata	API reference
iris.common.mixin	API reference
iris.common.resolve	API reference
iris.coord_categorisation	API reference
iris.coord_systems	API reference
iris.coords	API reference
iris.cube	API reference
iris.experimental.representation	API reference
iris.experimental.ugrid	API reference
iris.mesh	API reference
iris.mesh.components	API reference
iris.mesh.utils	API reference
iris.time	API reference
iris.util	API reference
Glossary	Information on common terms used within Iris documentation.

topic: slice_combine

Pages about subsetting and combining Cube and CubeList data. Examples include slicing, indexing, merging, concatenating.

All topic: data_model topic: slice_combine topic: load_save topic: lazy_data topic: plotting topic: maths_stats topic: regrid topic: customisation topic: troubleshooting topic: experimental topic: interoperability topic: mesh topic: about

All

Cross Section Plots	How to visualise cross-sections of multi-dimensional Cubes.
Global Average Annual Temperature Plot	How to spatially constrain data, compute statistics and visualise a comparison.
Seasonal Ensemble Model Plots	How to use Iris in a complex real-world analysis scenario.
Oceanographic Profiles and T-S Diagrams	How to use Iris' for visualising oceanographic profile data, including scatter plotting.
Load a Time Series of Data From the NEMO Model	How to concatenate data from multiple NEMO files.
Controlling Merge and Concatenate	A lesson in fine-grain control of combining Iris Cubes.
Merge and Concatenate	A lesson in the various ways to combine Cubes along different dimensional axes.
Subsetting a Cube	A lesson on subsetting Iris Cubes by extraction, masking, and iteration.
iris	API reference
iris.cube	API reference
iris.iterate	API reference
iris.mesh.utils	API reference
iris.util	API reference
Glossary	Information on common terms used within Iris documentation.

Tutorial

Guided lessons for understanding a topic.

(Supports study, via action)

Controlling Merge and Concatenate	A lesson in fine-grain control of combining Iris Cubes.
Merge and Concatenate	A lesson in the various ways to combine Cubes along different dimensional axes.
Subsetting a Cube	A lesson on subsetting Iris Cubes by extraction, masking, and iteration.

Explanation

In-depth discussion for understanding concepts.

(Supports study, via theory)

No pages for this filter.

How-to

Step by step instructions for achieving a specific goal.

(Supports work, via action)

Cross Section Plots	How to visualise cross-sections of multi-dimensional Cubes.
Global Average Annual Temperature Plot	How to spatially constrain data, compute statistics and visualise a comparison.
Seasonal Ensemble Model Plots	How to use Iris in a complex real-world analysis scenario.
Oceanographic Profiles and T-S Diagrams	How to use Iris' for visualising oceanographic profile data, including scatter plotting.
Load a Time Series of Data From the NEMO Model	How to concatenate data from multiple NEMO files.

Reference

Concise information to look up when needed.

(Supports work, via theory)

iris	API reference
iris.cube	API reference
iris.iterate	API reference
iris.mesh.utils	API reference
iris.util	API reference
Glossary	Information on common terms used within Iris documentation.

topic: load_save

Pages about reading from files into the data model, and writing from the data model to files.

All topic: data_model topic: slice_combine topic: load_save topic: lazy_data topic: plotting topic: maths_stats topic: regrid topic: customisation topic: troubleshooting topic: experimental topic: interoperability topic: mesh topic: about

All

Missing Data Handling in Iris	Read about how Iris handles missing/masked data during Cube load/save/modification.
NetCDF I/O Handling in Iris	Read about how Iris loads and saves NetCDF files.
Iris Handling of PP and Fieldsfiles	Read about how Iris represents Met Office UM PP and Fieldsfiles data.
Loading a Cube From a Custom File Format	How to visualise data from a file Iris does not natively support.
Load a Time Series of Data From the NEMO Model	How to concatenate data from multiple NEMO files.
Working with Mesh Data	How to perform common Iris operations on unstructured mesh data.
Controlling Merge and Concatenate	A lesson in fine-grain control of combining Iris Cubes.
Speeding up Converting PP Files to NetCDF	A real-world demonstration of tuning Dask and Iris for better performance when saving data.
Loading Iris Cubes	A lesson in how Iris loading works.
Loading From and Saving To S3 Buckets	A lesson on using s3-fuse with Iris to load/save data from/to S3 buckets.
Saving Iris Cubes	A lesson on writing Iris Cubes to file in various formats.
iris	API reference
iris.fileformats	API reference
iris.fileformats.abf	API reference
iris.fileformats.cf	API reference
iris.fileformats.dot	API reference
iris.fileformats.name	API reference
iris.fileformats.name_loaders	API reference
iris.fileformats.netcdf	API reference
iris.fileformats.netcdf.loader	API reference
iris.fileformats.netcdf.saver	API reference
iris.fileformats.netcdf.ugrid_load	API reference
iris.fileformats.nimrod	API reference
iris.fileformats.nimrod_load_rules	API reference
iris.fileformats.pp	API reference
iris.fileformats.pp_load_rules	API reference
iris.fileformats.pp_save_rules	API reference
iris.fileformats.rules	API reference
iris.fileformats.um	API reference
iris.fileformats.um_cf_map	API reference
iris.io	API reference
iris.io.format_picker	API reference
iris.loading	API reference
Glossary	Information on common terms used within Iris documentation.

Tutorial

Guided lessons for understanding a topic.

(Supports study, via action)

Controlling Merge and Concatenate	A lesson in fine-grain control of combining Iris Cubes.
Speeding up Converting PP Files to NetCDF	A real-world demonstration of tuning Dask and Iris for better performance when saving data.
Loading Iris Cubes	A lesson in how Iris loading works.
Loading From and Saving To S3 Buckets	A lesson on using s3-fuse with Iris to load/save data from/to S3 buckets.
Saving Iris Cubes	A lesson on writing Iris Cubes to file in various formats.

Explanation

In-depth discussion for understanding concepts.

(Supports study, via theory)

Missing Data Handling in Iris	Read about how Iris handles missing/masked data during Cube load/save/modification.
NetCDF I/O Handling in Iris	Read about how Iris loads and saves NetCDF files.
Iris Handling of PP and Fieldsfiles	Read about how Iris represents Met Office UM PP and Fieldsfiles data.

How-to

Step by step instructions for achieving a specific goal.

(Supports work, via action)

Loading a Cube From a Custom File Format	How to visualise data from a file Iris does not natively support.
Load a Time Series of Data From the NEMO Model	How to concatenate data from multiple NEMO files.
Working with Mesh Data	How to perform common Iris operations on unstructured mesh data.

Reference

Concise information to look up when needed.

(Supports work, via theory)

iris	API reference
iris.fileformats	API reference
iris.fileformats.abf	API reference
iris.fileformats.cf	API reference
iris.fileformats.dot	API reference
iris.fileformats.name	API reference
iris.fileformats.name_loaders	API reference
iris.fileformats.netcdf	API reference
iris.fileformats.netcdf.loader	API reference
iris.fileformats.netcdf.saver	API reference
iris.fileformats.netcdf.ugrid_load	API reference
iris.fileformats.nimrod	API reference
iris.fileformats.nimrod_load_rules	API reference
iris.fileformats.pp	API reference
iris.fileformats.pp_load_rules	API reference
iris.fileformats.pp_save_rules	API reference
iris.fileformats.rules	API reference
iris.fileformats.um	API reference
iris.fileformats.um_cf_map	API reference
iris.io	API reference
iris.io.format_picker	API reference
iris.loading	API reference
Glossary	Information on common terms used within Iris documentation.

topic: lazy_data

Pages about Iris’ implementation of parallel and out-of-core data handling, via Dask. See Lazy Data.

All topic: data_model topic: slice_combine topic: load_save topic: lazy_data topic: plotting topic: maths_stats topic: regrid topic: customisation topic: troubleshooting topic: experimental topic: interoperability topic: mesh topic: about

All

Real and Lazy Data	Read about how Iris defers data loading from disk.
Dask Bags and Greedy Parallelism	A real-world demonstration of using Dask Bags with Iris, including hazards to watch out for.
Parallelising a Loop of Multiple Calls to a Third Party Library	A real-world demonstration of parallelising function calls with Dask.
Speeding up Converting PP Files to NetCDF	A real-world demonstration of tuning Dask and Iris for better performance when saving data.
iris.cube	API reference
Glossary	Information on common terms used within Iris documentation.

Tutorial

Guided lessons for understanding a topic.

(Supports study, via action)

Dask Bags and Greedy Parallelism	A real-world demonstration of using Dask Bags with Iris, including hazards to watch out for.
Parallelising a Loop of Multiple Calls to a Third Party Library	A real-world demonstration of parallelising function calls with Dask.
Speeding up Converting PP Files to NetCDF	A real-world demonstration of tuning Dask and Iris for better performance when saving data.

Explanation

In-depth discussion for understanding concepts.

(Supports study, via theory)

Real and Lazy Data	Read about how Iris defers data loading from disk.

How-to

Step by step instructions for achieving a specific goal.

(Supports work, via action)

No pages for this filter.

Reference

Concise information to look up when needed.

(Supports work, via theory)

iris.cube	API reference
Glossary	Information on common terms used within Iris documentation.

topic: plotting

Pages about Iris’ use of Cartopy or GeoVista to plot Cube data.

All topic: data_model topic: slice_combine topic: load_save topic: lazy_data topic: plotting topic: maths_stats topic: regrid topic: customisation topic: troubleshooting topic: experimental topic: interoperability topic: mesh topic: about

All

Applying a Filter to a Time-Series	How to apply a low pass filter to an Iris Cube via rolling_window().
Colouring Anomaly Data With Logarithmic Scaling	How to visualise values using a logarithmic scale.
Deriving the Coriolis Frequency Over the Globe	How to create your own Cube from computed data and visualise it.
Cross Section Plots	How to visualise cross-sections of multi-dimensional Cubes.
Calculating a Custom Statistic	How to define and use a custom aggregation operation, including visualisation.
Loading a Cube From a Custom File Format	How to visualise data from a file Iris does not natively support.
Quickplot of a 2D Cube on a Map	A demonstration of basic iris.quickplot use.
Test Data Showing Inset Plots	How to create inset plots within a main plot.
Multi-Line Temperature Profile Plot	How to plot multiple lines on a single plot with a legend.
Example of a Polar Stereographic Plot	A demonstration of plotting data defined on an alternative map projection.
Fitting a Polynomial	How to compute and plot a polynomial fit to 1D data in an Iris cube.
Plotting in Different Projections	How to overlay data from two different map projections and add graphics.
Rotated Pole Mapping	How to visualise data via different methods and coordinate systems.
Zonal Mean Diagram of Air Temperature	How to use aligned plots to visualise collapsed dimensional statistics.
Global Average Annual Temperature Plot	How to spatially constrain data, compute statistics and visualise a comparison.
Global Average Annual Temperature Maps	How to produce comparative maps of two files with a shared colour bar.
Ionosphere Space Weather	How to mask out values below a threshold in a plot.
Deriving Exner Pressure and Air Temperature	How to use Iris arithmetic to derive phenomena from existing cubes and plot them.
Hovmoller Diagram of Monthly Surface Temperature	How to collapse and plot Cubes to create a Hovmoller diagram.
Seasonal Ensemble Model Plots	How to use Iris in a complex real-world analysis scenario.
Plotting Wind Direction Using Barbs	How to use Iris to derive and plot wind barbs.
Plotting Wind Direction Using Quiver	How to use Iris to plot wind quivers.
Oceanographic Profiles and T-S Diagrams	How to use Iris' for visualising oceanographic profile data, including scatter plotting.
Load a Time Series of Data From the NEMO Model	How to concatenate data from multiple NEMO files.
Tri-Polar Grid Projected Plotting	How to visualise data defined on a tri-polar grid using different map projections.
Working with Mesh Data	How to perform common Iris operations on unstructured mesh data.
Plotting a Cube	A lesson on visualising Iris Cubes using Cartopy and Matplotlib.
iris.experimental.animate	API reference
iris.experimental.geovista	API reference
iris.palette	API reference
iris.plot	API reference
iris.quickplot	API reference
iris.symbols	API reference
Glossary	Information on common terms used within Iris documentation.

Tutorial

Guided lessons for understanding a topic.

(Supports study, via action)

Plotting a Cube	A lesson on visualising Iris Cubes using Cartopy and Matplotlib.

Explanation

In-depth discussion for understanding concepts.

(Supports study, via theory)

No pages for this filter.

How-to

Step by step instructions for achieving a specific goal.

(Supports work, via action)

Applying a Filter to a Time-Series	How to apply a low pass filter to an Iris Cube via rolling_window().
Colouring Anomaly Data With Logarithmic Scaling	How to visualise values using a logarithmic scale.
Deriving the Coriolis Frequency Over the Globe	How to create your own Cube from computed data and visualise it.
Cross Section Plots	How to visualise cross-sections of multi-dimensional Cubes.
Calculating a Custom Statistic	How to define and use a custom aggregation operation, including visualisation.
Loading a Cube From a Custom File Format	How to visualise data from a file Iris does not natively support.
Quickplot of a 2D Cube on a Map	A demonstration of basic iris.quickplot use.
Test Data Showing Inset Plots	How to create inset plots within a main plot.
Multi-Line Temperature Profile Plot	How to plot multiple lines on a single plot with a legend.
Example of a Polar Stereographic Plot	A demonstration of plotting data defined on an alternative map projection.
Fitting a Polynomial	How to compute and plot a polynomial fit to 1D data in an Iris cube.
Plotting in Different Projections	How to overlay data from two different map projections and add graphics.
Rotated Pole Mapping	How to visualise data via different methods and coordinate systems.
Zonal Mean Diagram of Air Temperature	How to use aligned plots to visualise collapsed dimensional statistics.
Global Average Annual Temperature Plot	How to spatially constrain data, compute statistics and visualise a comparison.
Global Average Annual Temperature Maps	How to produce comparative maps of two files with a shared colour bar.
Ionosphere Space Weather	How to mask out values below a threshold in a plot.
Deriving Exner Pressure and Air Temperature	How to use Iris arithmetic to derive phenomena from existing cubes and plot them.
Hovmoller Diagram of Monthly Surface Temperature	How to collapse and plot Cubes to create a Hovmoller diagram.
Seasonal Ensemble Model Plots	How to use Iris in a complex real-world analysis scenario.
Plotting Wind Direction Using Barbs	How to use Iris to derive and plot wind barbs.
Plotting Wind Direction Using Quiver	How to use Iris to plot wind quivers.
Oceanographic Profiles and T-S Diagrams	How to use Iris' for visualising oceanographic profile data, including scatter plotting.
Load a Time Series of Data From the NEMO Model	How to concatenate data from multiple NEMO files.
Tri-Polar Grid Projected Plotting	How to visualise data defined on a tri-polar grid using different map projections.
Working with Mesh Data	How to perform common Iris operations on unstructured mesh data.

Reference

Concise information to look up when needed.

(Supports work, via theory)

iris.experimental.animate	API reference
iris.experimental.geovista	API reference
iris.palette	API reference
iris.plot	API reference
iris.quickplot	API reference
iris.symbols	API reference
Glossary	Information on common terms used within Iris documentation.

topic: maths_stats

Pages about statistical and mathematical operations on Cube data, e.g. computing means, differences, etc.

All topic: data_model topic: slice_combine topic: load_save topic: lazy_data topic: plotting topic: maths_stats topic: regrid topic: customisation topic: troubleshooting topic: experimental topic: interoperability topic: mesh topic: about

All

Lenient Cube Maths	Read about the options for handling metadata differences during Cube maths.
Missing Data Handling in Iris	Read about how Iris handles missing/masked data during Cube load/save/modification.
Applying a Filter to a Time-Series	How to apply a low pass filter to an Iris Cube via rolling_window().
Colouring Anomaly Data With Logarithmic Scaling	How to visualise values using a logarithmic scale.
Calculating a Custom Statistic	How to define and use a custom aggregation operation, including visualisation.
Test Data Showing Inset Plots	How to create inset plots within a main plot.
Fitting a Polynomial	How to compute and plot a polynomial fit to 1D data in an Iris cube.
Zonal Mean Diagram of Air Temperature	How to use aligned plots to visualise collapsed dimensional statistics.
Global Average Annual Temperature Plot	How to spatially constrain data, compute statistics and visualise a comparison.
Deriving Exner Pressure and Air Temperature	How to use Iris arithmetic to derive phenomena from existing cubes and plot them.
Hovmoller Diagram of Monthly Surface Temperature	How to collapse and plot Cubes to create a Hovmoller diagram.
Seasonal Ensemble Model Plots	How to use Iris in a complex real-world analysis scenario.
Plotting Wind Direction Using Barbs	How to use Iris to derive and plot wind barbs.
Working with Mesh Data	How to perform common Iris operations on unstructured mesh data.
Cube Maths	A lesson in mathematical operations on Iris Cubes.
Cube Statistics	A lesson in statistical operations on Iris Cubes.
iris.analysis	API reference
iris.analysis.calculus	API reference
iris.analysis.cartography	API reference
iris.analysis.geometry	API reference
iris.analysis.maths	API reference
iris.analysis.stats	API reference
iris.analysis.trajectory	API reference
iris.common	API reference
iris.common.lenient	API reference
iris.common.resolve	API reference
iris.cube	API reference
Glossary	Information on common terms used within Iris documentation.

Tutorial

Guided lessons for understanding a topic.

(Supports study, via action)

Cube Maths	A lesson in mathematical operations on Iris Cubes.
Cube Statistics	A lesson in statistical operations on Iris Cubes.

Explanation

In-depth discussion for understanding concepts.

(Supports study, via theory)

Lenient Cube Maths	Read about the options for handling metadata differences during Cube maths.
Missing Data Handling in Iris	Read about how Iris handles missing/masked data during Cube load/save/modification.

How-to

Step by step instructions for achieving a specific goal.

(Supports work, via action)

Applying a Filter to a Time-Series	How to apply a low pass filter to an Iris Cube via rolling_window().
Colouring Anomaly Data With Logarithmic Scaling	How to visualise values using a logarithmic scale.
Calculating a Custom Statistic	How to define and use a custom aggregation operation, including visualisation.
Test Data Showing Inset Plots	How to create inset plots within a main plot.
Fitting a Polynomial	How to compute and plot a polynomial fit to 1D data in an Iris cube.
Zonal Mean Diagram of Air Temperature	How to use aligned plots to visualise collapsed dimensional statistics.
Global Average Annual Temperature Plot	How to spatially constrain data, compute statistics and visualise a comparison.
Deriving Exner Pressure and Air Temperature	How to use Iris arithmetic to derive phenomena from existing cubes and plot them.
Hovmoller Diagram of Monthly Surface Temperature	How to collapse and plot Cubes to create a Hovmoller diagram.
Seasonal Ensemble Model Plots	How to use Iris in a complex real-world analysis scenario.
Plotting Wind Direction Using Barbs	How to use Iris to derive and plot wind barbs.
Working with Mesh Data	How to perform common Iris operations on unstructured mesh data.

Reference

Concise information to look up when needed.

(Supports work, via theory)

iris.analysis	API reference
iris.analysis.calculus	API reference
iris.analysis.cartography	API reference
iris.analysis.geometry	API reference
iris.analysis.maths	API reference
iris.analysis.stats	API reference
iris.analysis.trajectory	API reference
iris.common	API reference
iris.common.lenient	API reference
iris.common.resolve	API reference
iris.cube	API reference
Glossary	Information on common terms used within Iris documentation.

topic: regrid

Pages about regridding (2D to 2D) and interpolation (ND to 1D) of data from one set of coordinates to another. Commonly used to move between different XY grids.

All topic: data_model topic: slice_combine topic: load_save topic: lazy_data topic: plotting topic: maths_stats topic: regrid topic: customisation topic: troubleshooting topic: experimental topic: interoperability topic: mesh topic: about

All

Which Regridder to Use	Read about the different regridders available in Iris.
Working with Mesh Data	How to perform common Iris operations on unstructured mesh data.
Cube Interpolation and Regridding	A lesson in Iris' interpolation and regridding functionality.
iris.analysis	API reference
iris.analysis.trajectory	API reference
iris.cube	API reference
iris.experimental.regrid	API reference
iris.experimental.regrid_conservative	API reference
Glossary	Information on common terms used within Iris documentation.

Tutorial

Guided lessons for understanding a topic.

(Supports study, via action)

Cube Interpolation and Regridding	A lesson in Iris' interpolation and regridding functionality.

Explanation

In-depth discussion for understanding concepts.

(Supports study, via theory)

Which Regridder to Use	Read about the different regridders available in Iris.

How-to

Step by step instructions for achieving a specific goal.

(Supports work, via action)

Working with Mesh Data	How to perform common Iris operations on unstructured mesh data.

Reference

Concise information to look up when needed.

(Supports work, via theory)

iris.analysis	API reference
iris.analysis.trajectory	API reference
iris.cube	API reference
iris.experimental.regrid	API reference
iris.experimental.regrid_conservative	API reference
Glossary	Information on common terms used within Iris documentation.

topic: customisation

Pages about configurable Iris behaviour.

All topic: data_model topic: slice_combine topic: load_save topic: lazy_data topic: plotting topic: maths_stats topic: regrid topic: customisation topic: troubleshooting topic: experimental topic: interoperability topic: mesh topic: about

All

Controlling Merge and Concatenate	A lesson in fine-grain control of combining Iris Cubes.
iris	API reference
iris.config	API reference
Glossary	Information on common terms used within Iris documentation.

Tutorial

Guided lessons for understanding a topic.

(Supports study, via action)

Controlling Merge and Concatenate	A lesson in fine-grain control of combining Iris Cubes.

Explanation

In-depth discussion for understanding concepts.

(Supports study, via theory)

No pages for this filter.

How-to

Step by step instructions for achieving a specific goal.

(Supports work, via action)

No pages for this filter.

Reference

Concise information to look up when needed.

(Supports work, via theory)

iris	API reference
iris.config	API reference
Glossary	Information on common terms used within Iris documentation.

topic: troubleshooting

Pages about problems/exceptions you may encounter when using Iris, and how to best handle them.

All topic: data_model topic: slice_combine topic: load_save topic: lazy_data topic: plotting topic: maths_stats topic: regrid topic: customisation topic: troubleshooting topic: experimental topic: interoperability topic: mesh topic: about

All

Filtering Warnings	How to customise Iris' warnings to only see those you need.
iris.exceptions	API reference
iris.warnings	API reference
Glossary	Information on common terms used within Iris documentation.

Tutorial

Guided lessons for understanding a topic.

(Supports study, via action)

No pages for this filter.

Explanation

In-depth discussion for understanding concepts.

(Supports study, via theory)

No pages for this filter.

How-to

Step by step instructions for achieving a specific goal.

(Supports work, via action)

Filtering Warnings	How to customise Iris' warnings to only see those you need.

Reference

Concise information to look up when needed.

(Supports work, via theory)

iris.exceptions	API reference
iris.warnings	API reference
Glossary	Information on common terms used within Iris documentation.

topic: experimental

Pages about API that is still subject to change.

All topic: data_model topic: slice_combine topic: load_save topic: lazy_data topic: plotting topic: maths_stats topic: regrid topic: customisation topic: troubleshooting topic: experimental topic: interoperability topic: mesh topic: about

All

iris.experimental	API reference
iris.experimental.animate	API reference
iris.experimental.geovista	API reference
iris.experimental.regrid	API reference
iris.experimental.regrid_conservative	API reference
iris.experimental.representation	API reference
iris.experimental.stratify	API reference
iris.experimental.ugrid	API reference

Tutorial

Guided lessons for understanding a topic.

(Supports study, via action)

No pages for this filter.

Explanation

In-depth discussion for understanding concepts.

(Supports study, via theory)

No pages for this filter.

How-to

Step by step instructions for achieving a specific goal.

(Supports work, via action)

No pages for this filter.

Reference

Concise information to look up when needed.

(Supports work, via theory)

iris.experimental	API reference
iris.experimental.animate	API reference
iris.experimental.geovista	API reference
iris.experimental.regrid	API reference
iris.experimental.regrid_conservative	API reference
iris.experimental.representation	API reference
iris.experimental.stratify	API reference
iris.experimental.ugrid	API reference

topic: interoperability

Pages about using Iris alongside other libraries and tools.

All topic: data_model topic: slice_combine topic: load_save topic: lazy_data topic: plotting topic: maths_stats topic: regrid topic: customisation topic: troubleshooting topic: experimental topic: interoperability topic: mesh topic: about

All

Iris ❤️ Xarray	Read about the similarities and differences between Iris and Xarray.
Mesh Partner Packages	Read about Python packages you can use alongside Iris to work with mesh data.
Plotting in Different Projections	How to overlay data from two different map projections and add graphics.
Converting Other Mesh Formats	How to convert other mesh formats into Iris' Mesh Data Model.
Plugins	How to create and use plugins to extend Iris' functionality.
iris.experimental.geovista	API reference
iris.experimental.stratify	API reference
iris.pandas	API reference
Phrasebook	Information on terminology differences between Iris and similar packages.

Tutorial

Guided lessons for understanding a topic.

(Supports study, via action)

No pages for this filter.

Explanation

In-depth discussion for understanding concepts.

(Supports study, via theory)

Iris ❤️ Xarray	Read about the similarities and differences between Iris and Xarray.
Mesh Partner Packages	Read about Python packages you can use alongside Iris to work with mesh data.

How-to

Step by step instructions for achieving a specific goal.

(Supports work, via action)

Plotting in Different Projections	How to overlay data from two different map projections and add graphics.
Converting Other Mesh Formats	How to convert other mesh formats into Iris' Mesh Data Model.
Plugins	How to create and use plugins to extend Iris' functionality.

Reference

Concise information to look up when needed.

(Supports work, via theory)

iris.experimental.geovista	API reference
iris.experimental.stratify	API reference
iris.pandas	API reference
Phrasebook	Information on terminology differences between Iris and similar packages.

topic: mesh

Pages about Iris’ support for unstructured mesh data.

All topic: data_model topic: slice_combine topic: load_save topic: lazy_data topic: plotting topic: maths_stats topic: regrid topic: customisation topic: troubleshooting topic: experimental topic: interoperability topic: mesh topic: about

All

The Mesh Data Model	Read about how Iris represents unstructured mesh data.
Mesh Partner Packages	Read about Python packages you can use alongside Iris to work with mesh data.
Converting Other Mesh Formats	How to convert other mesh formats into Iris' Mesh Data Model.
Working with Mesh Data	How to perform common Iris operations on unstructured mesh data.
iris.experimental.ugrid	API reference
iris.fileformats.netcdf.ugrid_load	API reference
iris.mesh	API reference
iris.mesh.components	API reference
iris.mesh.utils	API reference

Tutorial

Guided lessons for understanding a topic.

(Supports study, via action)

No pages for this filter.

Explanation

In-depth discussion for understanding concepts.

(Supports study, via theory)

The Mesh Data Model	Read about how Iris represents unstructured mesh data.
Mesh Partner Packages	Read about Python packages you can use alongside Iris to work with mesh data.

How-to

Step by step instructions for achieving a specific goal.

(Supports work, via action)

Converting Other Mesh Formats	How to convert other mesh formats into Iris' Mesh Data Model.
Working with Mesh Data	How to perform common Iris operations on unstructured mesh data.

Reference

Concise information to look up when needed.

(Supports work, via theory)

iris.experimental.ugrid	API reference
iris.fileformats.netcdf.ugrid_load	API reference
iris.mesh	API reference
iris.mesh.components	API reference
iris.mesh.utils	API reference

topic: about

Pages about the non-code aspects of Iris: philosophy, installation, etc.

All topic: data_model topic: slice_combine topic: load_save topic: lazy_data topic: plotting topic: maths_stats topic: regrid topic: customisation topic: troubleshooting topic: experimental topic: interoperability topic: mesh topic: about

All

Iris' Philosophy	Read about how and why Iris is made the way it is.
Reviewing the Iris User Experience	Read about how we plan to review and improve the user experience of Iris.
Why Iris	Read about the Iris Python package and why you might want to use it.
Installing	How to install the Iris Python package.
Plugins	How to create and use plugins to extend Iris' functionality.
Citing Iris	Information on the correct way to cite the Iris Python package.
Glossary	Information on common terms used within Iris documentation.

Tutorial

Guided lessons for understanding a topic.

(Supports study, via action)

No pages for this filter.

Explanation

In-depth discussion for understanding concepts.

(Supports study, via theory)

Iris' Philosophy	Read about how and why Iris is made the way it is.
Reviewing the Iris User Experience	Read about how we plan to review and improve the user experience of Iris.
Why Iris	Read about the Iris Python package and why you might want to use it.

How-to

Step by step instructions for achieving a specific goal.

(Supports work, via action)

Installing	How to install the Iris Python package.
Plugins	How to create and use plugins to extend Iris' functionality.

Reference

Concise information to look up when needed.

(Supports work, via theory)

Citing Iris	Information on the correct way to cite the Iris Python package.
Glossary	Information on common terms used within Iris documentation.