set_of_runs
===========

.. py:module:: set_of_runs


Attributes
----------

.. autoapisummary::

   set_of_runs.jobname
   set_of_runs.savedir
   set_of_runs.config_file
   set_of_runs.config_dict
   set_of_runs.run_type
   set_of_runs.x_vars
   set_of_runs.var_pairs


Functions
---------

.. autoapisummary::

   set_of_runs.create_run_sub_dir


Module Contents
---------------

.. py:data:: jobname

.. py:data:: savedir
   :value: 'HPC_runs/_Uninferable/'


.. py:data:: config_file

.. py:data:: config_dict

.. py:data:: run_type

.. py:function:: create_run_sub_dir(savedir, jobname, x_vars, run_type, config_dict)

   Create a subdirectory given the set of parameters.

   Make a subdirectory for a run in a set of runs specified by the jobname and create the appropriate configuration file for that run.

   :param savedir: The base directory in which to create the subdirectory.
   :type savedir: `str`
   :param jobname: The name of the job / set of runs.
   :type jobname: `str`
   :param x_vars: The list of x variables to consider for this run
   :type x_vars: `list`
   :param run_type: The type of set of runs to do.
                    Example: 'zfi_set' for a set of runs to test Zeroed Feature Importance.
   :type run_type: `str`
   :param config_dict: The configuration dictionary to modify for this run.
   :type config_dict: `dict`


.. py:data:: x_vars

.. py:data:: var_pairs
   :value: [['no2', 'no2_tm1'], ['ssrd', 'sp'], ['u10', 'v10']]