see issue #164 for where these thoughts come from. My bones to pick with fre cmor run are:
1. Will not create $outdir/tmp for you
if the tool desires a temporary directory to accomplish it's mission, it should create it as-needed, and perhaps, remove it later as well. Exiting upon a temp directory not existing does not make sense.
2. Rename some input argument fields
outdir is very misleading- part of the point of the cmor library is to create a specific directory structure. this argument name gives the user a misleading impression that they have control over that structure. Really, outdir here is more like an output directory root or prefix.
varlist is also misleading. In python land, one might assume this means this argument could be a literal python list. This is not the case at all- this argument is supposed to be a JSON dictionary of the input variable names (keys) and desired output variable names (values).
3. re-rig help-menu
current help menu:
Options:
-d, --indir TEXT Input directory [required]
-l, --varlist TEXT Variable list [required]
-r, --table_config TEXT Table configuration [required]
-p, --exp_config TEXT Experiment configuration [required]
-o, --outdir TEXT Output directory [required]
--help Show this message and exit.
i'm not sure what my preferred change here is- but somewhere, it should be mentioned that varlist, table_config and exp_config input fields are TEXTthat represents the path to a JSON file.
see issue #164 for where these thoughts come from. My bones to pick with
fre cmor runare:1. Will not create
$outdir/tmpfor youif the tool desires a temporary directory to accomplish it's mission, it should create it as-needed, and perhaps, remove it later as well. Exiting upon a temp directory not existing does not make sense.
2. Rename some input argument fields
outdiris very misleading- part of the point of thecmorlibrary is to create a specific directory structure. this argument name gives the user a misleading impression that they have control over that structure. Really,outdirhere is more like an output directoryrootorprefix.varlistis also misleading. In python land, one might assume this means this argument could be a literal python list. This is not the case at all- this argument is supposed to be a JSON dictionary of the input variable names (keys) and desired output variable names (values).3. re-rig help-menu
current help menu:
i'm not sure what my preferred change here is- but somewhere, it should be mentioned that
varlist,table_configandexp_configinput fields areTEXTthat represents the path to a JSON file.