Runing the model#
Work in progress.
Running#
The model requires a config file to run. Examples are given in the config.example directory. The examples are commented and should be relatively self-explanatory. Copy one of these to a new file and edit as you wish. Make sure the directories you specify for output data and logs exist, otherwise the model will fail. Then pass this config file as the first argument when calling the model executable. For example, if you have installed the model to somewhere on your path:
$ mkdir config && cp config.example/config.example.nml config/my_config.nml
$ nanofase config/my_config.nml
Or if you wish to run via fpm without installing:
# Debug version
$ fpm @run -- config/my_config.nml
# Release version with optimisations
$ fpm @release -- config/my_config.nml
Input data#
The config file is responsible for telling the model where the input data are (via the &data group). To compile your own input data for the NanoFASE model, it is highly recommended that you use the NanoFASE data module. This module is responsible for (amongst other things) compiling multiple spatial and/or temporal input files into the main NetCDF input file required by the model.
Output data#
Output data are documented here.
Batch runs and checkpointing#
The model allows for multiple simulations to be chained together into batch runs, and model simulations to be saved and reinstated by use of checkpointing. See the following for more details:
Example workflows#
A few example workflows are provided in Example workflows.