-3.10.0.dev23-gold?style=flat){kind=icon}
iris.fileformats.name_loaders#
NAME file format loading functions.
- class iris.fileformats.name_loaders.NAMECoord(name, dimension, values)#
Bases:
tupleCreate new instance of NAMECoord(name, dimension, values)
- count(value, /)#
Return number of occurrences of value.
- dimension#
Alias for field number 1
- index(value, start=0, stop=9223372036854775807, /)#
Return first index of value.
Raises ValueError if the value is not present.
- name#
Alias for field number 0
- values#
Alias for field number 2
- iris.fileformats.name_loaders.load_NAMEIII_field(filename)[source]#
Load NAME III cubes.
Load a NAME III grid output file returning a generator of
iris.cube.Cubeinstances.- Parameters:
filename (str) – Name of file to load.
- Return type:
A generator
iris.cube.Cubeinstances.
- iris.fileformats.name_loaders.load_NAMEIII_timeseries(filename)[source]#
Load a NAME III time series file.
Load a NAME III time series file returning a generator of
iris.cube.Cubeinstances.- Parameters:
filename (str) – Name of file to load.
- Return type:
A generator
iris.cube.Cubeinstances.
- iris.fileformats.name_loaders.load_NAMEIII_trajectory(filename)[source]#
Load a NAME III trajectory file.
Load a NAME III trajectory file returning a generator of
iris.cube.Cubeinstances.- Parameters:
filename (str) – Name of file to load.
- Return type:
A generator
iris.cube.Cubeinstances.
- iris.fileformats.name_loaders.load_NAMEIII_version2(filename)[source]#
Load a NAME III version 2 file.
Load a NAME III version 2 file returning a generator of
iris.cube.Cubeinstances.- Parameters:
filename (str) – Name of file to load.
- Return type:
A generator
iris.cube.Cubeinstances.
- iris.fileformats.name_loaders.load_NAMEII_field(filename)[source]#
Load a NAME II grid output file.
Load a NAME II grid output file returning a generator of
iris.cube.Cubeinstances.- Parameters:
filename (str) – Name of file to load.
- Return type:
A generator
iris.cube.Cubeinstances.
- iris.fileformats.name_loaders.load_NAMEII_timeseries(filename)[source]#
Load a NAME III time series file.
Load a NAME II Time Series file returning a generator of
iris.cube.Cubeinstances.- Parameters:
filename (str) – Name of file to load.
- Return type:
A generator
iris.cube.Cubeinstances.
- iris.fileformats.name_loaders.read_header(file_handle)[source]#
Return a dictionary containing the header information.
Return a dictionary containing the header information extracted from the the provided NAME file object.
- Parameters:
file_handle (file-like object) – A file-like object from which to read the header information.
- Return type:
A dictionary containing the extracted header information.