You are viewing the latest unreleased documentation 3.10.0.dev14. You can switch to a stable version.

iris.fileformats.dot#

Provides Creation and saving of DOT graphs for a iris.cube.Cube.

iris.fileformats.dot.DOT_AVAILABLE = True#

Whether the ‘dot’ program is present (required for “dotpng” output).

iris.fileformats.dot.cube_text(cube)[source]#

Return a DOT text representation a iris.cube.Cube.

Parameters:

cube – The cube for which to create DOT text.

iris.fileformats.dot.save(cube, target)[source]#

Save a dot representation of the cube.

Parameters:
  • cube (iris.cube.Cube) –

  • target – A filename or open file handle.

See also

iris.io.save

Save one or more Cubes to file (or other writeable).

iris.fileformats.dot.save_png(source, target, launch=False)[source]#

Produce a “dot” instance diagram by calling dot.

Produce a “dot” instance diagram by calling dot and optionally launching the resulting image.

Parameters:
  • source (iris.cube.Cube, or dot filename) –

  • target – A filename or open file handle. If passing a file handle, take care to open it for binary output.

  • launch (bool, default=False) – Display the image. Default is False.

See also

iris.io.save

Save one or more Cubes to file (or other writeable).