polaris.mesh.spherical.SphericalBaseStep

class polaris.mesh.spherical.SphericalBaseStep(component, name, subdir)[source]

A base class for steps that create a JIGSAW spherical mesh

Variables:: opts (jigsawpy.jigsaw_jig_t) – JIGSAW options for creating the mesh

__init__(component, name, subdir)[source]

Create a new step

Parameters:

component (polaris.Component) – The component the step belongs to
name (str) – the name of the step
subdir ({str, None}) – the subdirectory for the step. The default is name

Methods

`__init__`(component, name, subdir)	Create a new step
`add_dependency`(step[, name])	Add step as a dependency of this step (i.e.
`add_input_file`([filename, target, database, ...])	Add an input file to the step (but not necessarily to the MPAS model).
`add_output_file`(filename[, validate_vars])	Add the output file that must be produced by this step and may be made available as an input to steps, perhaps in other tasks.
`constrain_resources`(available_resources)	Constrain `cpus_per_task` and `ntasks` based on the number of cores available to this step
`process_inputs_and_outputs`()	Process the inputs to and outputs from a step added with `polaris.Step.add_input_file()` and `polaris.Step.add_output_file()`.
`run`()	Finish up the step.
`runtime_setup`()	Update attributes of the step at runtime before calling the `run()` method.
`save_and_plot_cell_width`(lon, lat, cell_width)	Save the cell width field on a lon/lat grid to `self.cell_width_filename` and plot
`set_resources`([cpus_per_task, ...])	Update the resources for the subtask.
`set_shared_config`(config[, link])	Replace the step's config parser with the shared config parser
`setup`()	Add output files
`validate_baselines`()	Compare variables between output files in this step and in the same step from a baseline run if one was provided.