Source code for compass.landice.tests.hydro_radial.run_model

from compass.model import run_model
from compass.step import Step


[docs] class RunModel(Step): """ A step for performing forward MALI runs as part of radially symmetric hydrological test cases. suffixes : list of str, optional a list of suffixes for namelist and streams files produced for this step. Most steps most runs will just have a ``namelist.landice`` and a ``streams.landice`` (the default) but the ``restart_run`` step of the ``restart_test`` runs the model twice, the second time with ``namelist.landice.rst`` and ``streams.landice.rst`` """
[docs] def __init__(self, test_case, name='run_model', subdir=None, ntasks=1, min_tasks=None, openmp_threads=1, suffixes=None): """ Create a new test case Parameters ---------- test_case : compass.TestCase The test case this step belongs to name : str, optional the name of the test case subdir : str, optional the subdirectory for the step. The default is ``name`` ntasks : int, optional the number of tasks the step would ideally use. If fewer tasks are available on the system, the step will run on all available tasks as long as this is not below ``min_tasks`` min_tasks : int, optional the number of tasks the step requires. If the system has fewer than this number of tasks, the step will fail openmp_threads : int, optional the number of OpenMP threads the step will use suffixes : list of str, optional a list of suffixes for namelist and streams files produced for this step. Most steps most runs will just have a ``namelist.landice`` and a ``streams.landice`` (the default) but the ``restart_run`` step of the ``restart_test`` runs the model twice, the second time with ``namelist.landice.rst`` and ``streams.landice.rst`` """ if suffixes is None: suffixes = ['landice'] self.suffixes = suffixes if min_tasks is None: min_tasks = ntasks super().__init__(test_case=test_case, name=name, subdir=subdir, ntasks=ntasks, min_tasks=min_tasks, openmp_threads=openmp_threads) for suffix in suffixes: self.add_namelist_file( 'compass.landice.tests.hydro_radial', 'namelist.landice', out_name='namelist.{}'.format(suffix)) self.add_streams_file( 'compass.landice.tests.hydro_radial', 'streams.landice', out_name='streams.{}'.format(suffix)) self.add_input_file(filename='landice_grid.nc', target='../setup_mesh/landice_grid.nc') self.add_input_file(filename='graph.info', target='../setup_mesh/graph.info') self.add_model_as_input() self.add_output_file(filename='output.nc')
# no setup() is needed
[docs] def run(self): """ Run this step of the test case """ for suffix in self.suffixes: run_model(step=self, namelist='namelist.{}'.format(suffix), streams='streams.{}'.format(suffix))