From 31fc958030f9acf09f61cfd234162d67ced5b6c8 Mon Sep 17 00:00:00 2001 From: zmoon Date: Mon, 4 Nov 2024 16:09:35 -0600 Subject: [PATCH] Add doc --- docs/appendix/yaml.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/appendix/yaml.rst b/docs/appendix/yaml.rst index 5f1f3030..3a4fbc08 100644 --- a/docs/appendix/yaml.rst +++ b/docs/appendix/yaml.rst @@ -75,6 +75,9 @@ regarding the directory files are read from. * **method:** The file format to read from. Options are 'netcdf' and 'pkl'. * **filenames:** The filename(s) that should be read in. For method: 'netcdf' this must be set as a dict in the form filenames: {'group1':str or iterable of filename(s) in group1, group2: str or iterable of filename(s) in group2,...}. For method: 'pkl' this must be set as either a string with the filename or as an or iterable of filenames. Wildcards will be expanded to any matching files. +**add_logo:** This is an optional argument. +Set this to ``false`` to forgo adding the MELODIES MONET logo to the plots. + Models ------ All input for each instance of the model class. First level should be the model