Command-line Interface
glotaran
The glotaran CLI main function.
glotaran [OPTIONS] COMMAND [ARGS]...
Options
- --version
Show the version and exit.
optimize
Optimizes a model. e.g.: glotaran optimize –
glotaran optimize [OPTIONS] [SCHEME_FILE]
Options
- -dfmt, --dataformat <dataformat>
The input format of the data. Will be inferred from extension if not set.
- Options:
ascii | nc | sdt
- -d, --data <data>
Path to a dataset in the form ‘–data DATASET_LABEL PATH_TO_DATA’
- -o, --out <out>
Path to an output directory.
- -ofmt, --outformat <outformat>
The format of the output.
- Default:
folder- Options:
folder | legacy | yaml
- -n, --nfev <nfev>
Maximum number of function evaluations.
- --nnls
Use non-negative least squares.
- -y, --yes
Don’t ask for confirmation.
- -p, --parameters_file <parameters_file>
(optional) Path to parameter file.
- -m, --model_file <model_file>
Path to model file.
Arguments
- SCHEME_FILE
Optional argument
pluginlist
Prints a list of installed plugins.
glotaran pluginlist [OPTIONS]
print
Parses scheme, a model or a parameter file and prints the result as a Markdown formatted string.
glotaran print [OPTIONS] [SCHEME_FILE]
Options
- -p, --parameters_file <parameters_file>
(optional) Path to parameter file.
- -m, --model_file <model_file>
Path to model file.
Arguments
- SCHEME_FILE
Optional argument
validate
Validates a model file and optionally a parameter file.
glotaran validate [OPTIONS] [SCHEME_FILE]
Options
- -p, --parameters_file <parameters_file>
(optional) Path to parameter file.
- -m, --model_file <model_file>
Path to model file.
Arguments
- SCHEME_FILE
Optional argument