Skip to main content
Ctrl+K
Iris 3.12.2 documentation - Home Iris 3.12.2 documentation - Home
  • Getting Started
  • User Guide
  • Developers Guide
  • Community
  • What’s New in Iris
  • Iris API
  • GitHub
  • Twitter
  • GitHub Discussions
  • PyPI
  • Conda
  • Getting Started
  • User Guide
  • Developers Guide
  • Community
  • What’s New in Iris
  • Iris API
  • GitHub
  • Twitter
  • GitHub Discussions
  • PyPI
  • Conda
Ctrl+K

Section Navigation

Developers Guide

  • Working With Iris Source Code
    • Introduction
    • Making Your own Copy (fork) of Iris
    • Set up Your Fork
    • Configure Git
    • Development Workflow
  • How to Contribute to the Documentation
    • Contributing to the Documentation (the easy way)
    • Contributing to the Documentation
  • Working with the Code Base
    • Code Formatting
    • Docstrings
    • reST Quick Start
    • Deprecations
    • Testing
      • Writing Tests
      • Adding or Updating Graphics Tests
      • Running the Tests
      • Continuous Integration (CI) Testing
      • Benchmarking
      • Converting From unittest to pytest
  • Contributing Your Changes
    • Contributing a “What’s New” Entry
    • Pull Request Checklist
  • Token GitHub App
  • Releases

Reference

  • iris
    • iris.analysis
      • iris.analysis.calculus
      • iris.analysis.cartography
      • iris.analysis.geometry
      • iris.analysis.maths
      • iris.analysis.stats
      • iris.analysis.trajectory
    • iris.common
      • iris.common.lenient
      • iris.common.metadata
      • iris.common.mixin
      • iris.common.resolve
    • iris.experimental
      • iris.experimental.animate
      • iris.experimental.geovista
      • iris.experimental.regrid
      • iris.experimental.regrid_conservative
      • iris.experimental.representation
      • iris.experimental.stratify
      • iris.experimental.ugrid
    • iris.fileformats
      • iris.fileformats.netcdf
      • iris.fileformats.um
      • iris.fileformats.abf
      • iris.fileformats.cf
      • iris.fileformats.dot
      • iris.fileformats.name
      • iris.fileformats.name_loaders
      • iris.fileformats.nimrod
      • iris.fileformats.nimrod_load_rules
      • iris.fileformats.pp
      • iris.fileformats.pp_load_rules
      • iris.fileformats.pp_save_rules
      • iris.fileformats.rules
      • iris.fileformats.um_cf_map
    • iris.io
      • iris.io.format_picker
    • iris.mesh
      • iris.mesh.components
      • iris.mesh.utils
    • iris.aux_factory
    • iris.config
    • iris.coord_categorisation
    • iris.coord_systems
    • iris.coords
    • iris.cube
    • iris.exceptions
    • iris.iterate
    • iris.loading
    • iris.palette
    • iris.pandas
    • iris.plot
    • iris.quickplot
    • iris.symbols
    • iris.time
    • iris.util
    • iris.warnings
  • What’s New in Iris
    • v3.12 (24 Mar 2025)
    • v3.11 (11 Nov 2024)
    • v3.10 (13 Aug 2024)
    • v3.9 (22 Apr 2024)
    • v3.8 (29 Feb 2024)
    • v3.7 (31 Aug 2023)
    • v3.6 (18 May 2023)
    • v3.5 (27 Apr 2023)
    • v3.4 (01 Dec 2022)
    • v3.3 (1 Sep 2022)
    • v3.2 (15 Feb 2022)
    • v3.1 (17 Sep 2021)
    • v3.0 (25 Jan 2021)
    • v2.4 (20 Feb 2020)
    • v2.3 (19 Dec 2019)
    • v2.2 (11 Oct 2018)
    • v2.1 (06 Jun 2018)
    • v2.0 (14 Feb 2018)
    • v1.13 (17 May 2017)
    • v1.12 (31 Jan 2017)
    • v1.11 (29 Oct 2016)
    • v1.10 (05 Sep 2016)
    • v1.9 (10 Dec 2015)
    • v1.8 (14 Apr 2015)
    • v1.7 (04 Jul 2014)
    • v1.6 (26 Jan 2014)
    • v1.5 (13 Sep 2013)
    • v1.4 (14 Jun 2013)
    • v1.3 (27 Mar 2013)
    • v1.2 (28 Feb 2013)
    • v1.1 (03 Jan 2013)
    • v1.0 (17 Oct 2012)
  • Iris Copyright, Licensing and Contributors
  • Voted Issues
  • Developers Guide
  • Working with the Code Base

Working with the Code Base#

  • Code Formatting
    • Type Hinting
  • Docstrings
  • reST Quick Start
    • Creating Links
  • Deprecations
    • Adding a Deprecation
      • Removing a Public API
      • Changing a Default
    • Removing a Deprecation
      • Removing a Public API
      • Changing a Default
  • Testing
    • Writing Tests
      • Test Categories
      • PyTest Style Guide
      • Testing tools
    • Adding or Updating Graphics Tests
      • Generating New Results
      • Reviewing Failing Tests
      • Adding a New Image Test
      • Refreshing the Stored Hashes
      • Add Your Changes to Iris
    • Running the Tests
      • Testing Iris in a Manually Created Environment
      • Using Nox for Testing Iris
    • Continuous Integration (CI) Testing
      • GitHub Actions
      • CLA Assistant
      • pre-commit CI
    • Benchmarking
      • Continuous Integration
      • Other Uses
    • Converting From unittest to pytest
      • Conversion Checklist
      • Common Translations

previous

Contributing to the Documentation

next

Code Formatting

Edit on GitHub

This Page

  • Show Source

© Copyright 2010 - 2025, Iris Contributors.

Created using Sphinx 8.1.3.

Built using Python 3.12.10.