polaris.tasks.e3sm.init.topo.combine.get_cubed_sphere_topo_steps
- polaris.tasks.e3sm.init.topo.combine.get_cubed_sphere_topo_steps(component, resolution, include_viz=False)[source]
Get shared combined-topography steps for a cubed-sphere target grid.
The
CombineStep(andVizCombinedStepwhen requested) setdefault_cached = Truein their constructors because they are expensive to produce. Downstream tasks benefit from cached outputs automatically. Tasks that require free-running execution (e.g. standalone combine tasks) should add each returned step’ssubdirtoself.free_running_stepsin their__init__, asCubedSphereCombineTaskdoes.- Parameters:
component (polaris.Component) – The component that the steps will be added to.
resolution (int) – The cubed-sphere resolution, such as 3000 or 120.
include_viz (bool, optional) – Whether to include the visualization step or not.
- Returns:
steps (dict of str to polaris.Step) – The combine topo step and optional visualization step, keyed by step name.
config (polaris.config.PolarisConfigParser) – The shared config options.