Experiments_file_handling

Docstrings for the Experiments_file_handling class

Objects

experiments()
nemo_filename_maker()

Set of functions to control basic experiment file handling

experiments()


def experiments(experiments=experiments.json):

Reads a json formatted files, default name is experiments.json
for lists of:
experiment names (exp_names)
directory names (dir names)
domain file names (domains)
file names (file_names)


Parameters
----------
experiments : TYPE, optional
                DESCRIPTION. The default is 'experiments.json'.

Returns
-------
exp_names,dirs,domains,file_names

nemo_filename_maker()


def nemo_filename_maker(directory, year_start, year_stop, grid=T):

Creates a list of NEMO file names from a set of standard templates.

Args:
                directory: path to the files'
                year_start: start year
                year_stop: stop year
                grid: NEMO grid type defaults to T

Returns: a list of possible nemo file names


Last modified November 23, 2022: Updated docstrings from coast repo. (9daee18)