polaris.tasks.ocean.realistic_global.forcing.jra55.Jra55StressStep

class polaris.tasks.ocean.realistic_global.forcing.jra55.Jra55StressStep(component, subdir)[source]

A step for deriving a time-invariant global wind-stress product from JRA55-do 10-m winds.

The stress is computed at every 3-hourly step and then time-averaged, rather than computing the stress of the time-mean wind. Averaging the wind first would discard the gust contribution and underestimate the stress in the storm tracks, which is the reason the 3-hourly data is needed at all.

The reduction itself is quick, but it needs several GiB of raw reanalysis, so the derived product is distributed through the Polaris cache and this step is default_cached. The standalone Jra55 task overrides that to regenerate the product.

__init__(component, subdir)[source]

Create the step.

Parameters:
  • component (polaris.Component) – The component the step belongs to.

  • subdir (str) – The subdirectory for the step.

Methods

__init__(component, subdir)

Create the step.

add_cf_check([filename])

Check an output file for CF compliance after the step runs.

add_dependency(step[, name])

Add step as a dependency of this step (i.e. this step can't run until the dependency has finished).

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 to the step

add_property_check(filename, check_properties)

Add a single conservation comparison for an output file

check_cf()

Check the files added with add_cf_check() for CF compliance.

check_properties()

Check conservation properties of the output files of this step.

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()

Average the wind stress over the configured month and write the product.

runtime_setup()

Update attributes of the step at runtime before calling the run() method.

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()

Declare the raw JRA55-do wind files, whose URLs are built from config.

validate_baselines()

Compare variables between output files in this step and in the same step from a baseline run if one was provided.

work_path(*filenames)

Get the absolute path to a file or directory in the step's work directory

Attributes

cores

the number of cores this step needs, in total

gpus

the number of GPUs this step needs, in total

may_span_nodes

whether this step's cores and GPUs may come from several nodes

min_cores

the number of cores this step needs in order to run at all

min_gpus

the number of GPUs this step requires, in total