The creation of a Nek5000 setup using the framework starts with collecting information about required modules and their dependencies. The most important is a list of provided and required interfaces for each of the modules. With a complete list of required modules, the user can build the setup's makefile_usr.inc concatenating corresponding files from modules' home directories in the toolbox. Next, the compile_script has to be generated and all the object files from makefile_usr.inc have to be included in USR variable. Please observe that the compilation script has to contain a call to toolbox_path.sh. To make a source code complete one has to copy all the template Fortran77 include-files from the modules' home directories to the setup directory, dropping the _template extension. The content of these files has to be checked and adjusted to the case needs. Next, the calls to the appropriate interfaces of the used modules have to be added to ###.usr file. Most of them should be added to the userchk subroutine, although in specific cases the other subroutines could be used as well. The most basic ones are calls to frame_start, frame_monitor and frame_end subroutines, which are interfaces of the Frame module module.

The last step before the compilation of the code is the generation of the user interfaces required by the used modules. The templates of these subroutines can be found in example.usr files in modules' directories, but they should not be used directly without proper modification. Although this step is very case-dependent, the Frame module module is obligatory, so at least three user subroutines have to be added to the ###.usr file. These are frame_usr_register, frame_usr_init and frame_usr_end. They should contain calls to the modules' registration, initialisation and finalisation routines respectively, and are required by frame_start and frame_end subroutines.

To execute the code one needs the run-time parameter file ###.par which can be build based on example.par files located in modules' directories. Notice that these files contain module-specific parameter sections, so the general Nek5000 run-time parameters have to be added separately. Like all the other run-time parameters in Nek5000, the run-time parameters defined in the framework come with a default value and only those modified have to be present in the ###.par file. For the log level smaller or equal lp_prd (6) the list of all the registered framework run-time parameters can be found in the log file. We have to stress here, that the framework does not support the legacy run-time parameter file ###.rea.

For more details, the user is directed to KTH_Examples repository containing examples of all the existing tools in the framework.