polaris.tasks.ocean.analysis.sim_files.SimulationFiles

class polaris.tasks.ocean.analysis.sim_files.SimulationFiles(config, log=<built-in function print>)

The files of the simulation being analyzed

The simulation’s own Omega configuration is the analysis’ description of where its output lives: the mesh, the vertical coordinate and every output stream are read from it, so that none of them have to be restated in a Polaris config file. An Omega run always writes one, so its absence is an error rather than a case to fall back from.

Variables:

• config (polaris.config.PolarisConfigParser) – The config options for the analysis

• omega_config (OmegaConfig) – The simulation’s Omega configuration

• simulation_path (str) – The directory that relative file names are resolved against

• simulation_path_source (str) – Where simulation_path came from, for reporting

• simulation_name (str) – A short name for the simulation, used in plot titles and file names

__init__(config, log=<built-in function print>)

Resolve the simulation’s paths from its Omega configuration

Parameters:

• config (polaris.config.PolarisConfigParser) – The config options for the analysis

• log (callable, optional) – Where to report each resolved path and its source. The default, print, is what a step wants during setup(), where it has no logger yet; at run time a step passes self.logger.info.

Methods

__init__(config[, log])	Resolve the simulation's paths from its Omega configuration
global_stats_files(start_year, end_year)	Get the global statistics output files covering a range of years
global_stats_stream()	Get the output stream the global statistics are read from
mesh_filename()	Get the horizontal mesh file
moc_files(start_year, end_year)	Get the meridional overturning circulation output files covering a range of years
monthly_mean_files(start_year, end_year)	Get the monthly-mean output files covering a range of years
vert_coord_filename()	Get the vertical-coordinate file