Logo
latest

Getting Started

  • Installing Iris
  • Gallery

User Guide

  • Introduction
  • Iris Data Structures
  • Loading Iris Cubes
  • Saving Iris Cubes
  • Navigating a Cube
  • Subsetting a Cube
  • Real and Lazy Data
  • Plotting a Cube
  • Cube Interpolation and Regridding
  • Merge and Concatenate
  • Cube Statistics
  • Cube Maths
  • Citing Iris
  • Code Maintenance

Further Topics

  • Introduction
  • Metadata
  • Lenient Metadata
  • Lenient Cube Maths

Developers Guide

  • Getting Involved
  • Working With Iris Source Code
  • Contributing to the Documentation
  • Contributing to the Code Base
    • Code Formatting
    • Docstrings
    • reST Quick Start
    • Deprecations
    • Testing
  • Contributing Your Changes
  • Releases

Reference

  • Iris API
  • What’s New in Iris
  • Iris Technical Papers
  • Iris Copyright, Licensing and Contributors

Support

  • Source Code
  • Users Google Group
  • Developers Google Group
  • StackOverflow for "How Do I?"
  • Legacy Documentation
Iris
  • Docs »
  • Contributing to the Code Base
  • Edit on GitHub

You are viewing the latest unreleased documentation v3.1.dev0. You may prefer a stable version.

Contributing to the Code Base¶

  • Code Formatting
  • Docstrings
    • Single-Line Docstrings
    • Multi-Line Docstrings
      • Description
      • Sample Multi-Line Docstring
    • Documenting Classes
      • Attribute and Property 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
    • Test Categories
      • Unit Tests
      • Integration Tests
    • Graphics Tests
      • Challenges
      • Testing Strategy
      • Reviewing Failing Tests
      • Add Your Changes to Iris
    • Running the Tests
      • Using setuptools for Testing Iris
      • Using Nox for Testing Iris
    • Continuous Integration (CI) Testing
      • SciTools CLA Checker
      • Cirrus-CI
      • GitHub Checklist
Next Previous

© Copyright 2010 - 2021, Iris Contributors Revision a9ae72fa.

Built with Sphinx using a theme provided by Read the Docs. Built using Python 3.8.8.
Read the Docs v: latest
Versions
latest
stable
v3.0.1
v3.0.x
v3.0.0
v3.0.0rc0
Downloads
pdf
html
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.