polaris.tasks.ocean.analysis.sim_files.OmegaConfig

class polaris.tasks.ocean.analysis.sim_files.OmegaConfig(filename, streams, options)

The configuration file of the simulation being analyzed

Polaris reads the simulation’s own Omega configuration so that the mesh, the output streams and their file-name templates do not have to be restated by hand. This is the one place Polaris depends on the shape of Omega’s configuration rather than on its output, so every method here reports what it did not find rather than raising from deep inside a lookup.

Variables:

• filename (str) – The absolute path to the Omega configuration file

• streams (dict) – The contents of the IOStreams section

• options (dict) – The remaining options under the Omega section

__init__(filename, streams, options)

Methods

__init__(filename, streams, options)
analysis_group_status(group_name)	Report whether an analysis group is writing output
analysis_streams(group_name)	Get the output streams an analysis group writes
stream_filename(stream_name)	Get the file name or file-name template of an IOStreams entry
stream_status(stream_name)	Report whether an IOStreams entry can supply a file name