Source code for compass.landice.tests.ismip6_run.ismip6_ais_proj2300

import os

from compass.landice.tests.ismip6_run.ismip6_ais_proj2300.create_slm_mapping_files import (  # noqa
    CreateSlmMappingFiles,
)
from compass.landice.tests.ismip6_run.ismip6_ais_proj2300.set_up_experiment import (  # noqa
    SetUpExperiment,
)
from compass.testcase import TestCase




class Ismip6AisProj2300(TestCase):
    """
    A test case for automated setup of a suite of standardized
    simulations for ISMIP6-Projections2300-Antarctica
    See: https://www.climate-cryosphere.org/wiki/index.php?title=ISMIP6-Projections2300-Antarctica)  # noqa
    """



    def __init__(self, test_group):
        """
        Create the test case

        Parameters
        ----------
        test_group : compass.landice.tests.ismip6_run.Ismip6Run
            The test group that this test case belongs to

        """
        name = 'ismip6_ais_proj2300'

        super().__init__(test_group=test_group, name=name,
                         subdir=name)




    def configure(self):
        """
        Set up the desired ISMIP6 AIS 2300 experiments.

        Read the list from the config of which experiments the
        user wants to set up.  Call thee add_step method and add the
        experiment to steps_to_run.  Those operations are typically done
        in the constructor, but they are done here so that the list to set up
        can be adjusted in the config, and the config is not available until
        this point.
        """

        # user can specify any of: 'all', 'tier1', 'tier2', or a
        # comma-delimited list (or a single experiment)
        exp_list = self.config.get('ismip6_run_ais_2300', 'exp_list')
        if exp_list == "tier1":
            exp_list = ['hist', 'ctrlAE'] + \
                       [f'expAE{i:02}' for i in range(1, 7)]
        elif exp_list == "tier2":
            exp_list = [f'expAE{i:02}' for i in range(7, 15)]
        elif exp_list == "all":
            exp_list = ['hist', 'ctrlAE'] + \
                       [f'expAE{i:02}' for i in range(1, 15)]
        else:
            exp_list = exp_list.split(",")
        mesh_res = self.config.getint('ismip6_run_ais_2300', 'mesh_res')

        for exp in exp_list:
            if os.path.exists(os.path.join(self.work_dir, exp)):
                print(f"WARNING: {exp} path already exists; skipping.  "
                      "Please remove the directory "
                      f"{os.path.join(self.work_dir, exp)} and execute "
                      "'compass setup' again to set this experiment up.")
            else:
                exp_name = f'{exp}_{mesh_res:02}'
                self.add_step(
                    SetUpExperiment(test_case=self, name=exp_name,
                                    subdir=exp_name, exp=exp))
        # Do not add experiments to step to steps_to_run;
        # each experiment (step) should be run manually
        self.steps_to_run = []

        sea_level_model = self.config.getboolean('ismip6_run_ais_2300',
                                                 'sea_level_model')
        if sea_level_model:
            subdir = 'mapping_files'
            if os.path.exists(os.path.join(self.work_dir, subdir)):
                print(f"WARNING: {subdir} path already exists; skipping.  "
                      "Please remove the directory "
                      f"{os.path.join(self.work_dir, subdir)} and execute "
                      "'compass setup' again to set this experiment up.")
            else:
                self.add_step(
                    CreateSlmMappingFiles(test_case=self,
                                          name='mapping_files',
                                          subdir=subdir))
                self.steps_to_run.append('mapping_files')




    def run(self):
        """
        A dummy run method
        """
        raise ValueError("ERROR: 'compass run' has no functionality at the "
                         "test case level for this test.  "
                         "Please submit the job script in "
                         "each experiment's subdirectory manually instead."
                         "To create Sea-Level Model mapping files, submit"
                         "job script or execute 'compass run' from the"
                         "'mapping_files' subdirectory.")



    # no validate() method is needed