NONMEM runs can be invoked using the command line/shell script nmfe (NONMEM Front End). The script is appended with release version, e.g. nmfe75 for NONMEM v7.5. The basic use requires two arguments, model file and report file:

1
2

  nmfe75.bat model.ctl model.res # Windows
  nmfe75 model.ctl model.res # Linux/Unix

The run will output status, information, and messages on screen, to re-direct/save them, one may use

1
2

  nmfe75 model.ctl model.res >stdout.txt
  nmfe75 mycontrol.ctl myresults.res -background>console.txt

Some common additional options are listed below.

• -rundir. The user may enter a run directory that is different from the directory in which the script is launched:

  1	-rundir=c:\my_favorite_dir

  One must have all user dependent input files, control stream file, msf files, and data files, are available in that run directory.

• -nmexec. The user may also enter an alternative name for the constructed executable. For example,

  1	-nmexec=nonmem2

  specifies an alternative executable name nonmem2, than the default nonmem.exe (windows) or nonmem (Linux).

• -xmloff stops the XML output file from being created.

• -flushtime=x requests file updating (flushing) to occur not more than every x seconds. For example,

  1	-xmloff -flushtime=10.0

  may increase the simulation speed. File flushes for the MSF system are not affected, and continue to be updated every PRINT iterations during estimation. The default setting of flushtime is 1 second, suitable for most problems, but you can change this as needed (fractional seconds are also allowed). If you prefer file updates occurring as frequently as possible, you can set flushtime to 0.0, but this could cause considerable slowing of execution for small problems and data sets.

• Beginning in NM73, an additional feature of the execution script file is that the path to the fortran compiler system and MPI system that is appropriate for NONMEM may be retrieved from a script file that could have the following environment variables defined:

  1 2 3 4

  compilerpath mpibinpath mpilibpath mpilibname

  Comments in these files are provided for instructions about each of these environment variables. These paths will be temporarily added to the front of the PATH environment variable, so that the appropriate compiler or MPI system is called to service NONMEM. In the past, conflicts with other installed fortran compilers from other applications would prevent the appropriate compiler from being used for the NONMEM system. This location file method allows NONMEM to be forced to look in a particular location.

• -locfile specifies the location file (nmloc.bat or nmloc by convention. See util/nmlocoriginal.* as templates). For example

  1	nmfe75 myfile.ctl myfile.res -locfile=nmloc.bat

  If –locfile is not specified, the nmfe7x script looks in the present working directory for nmloc.bat (windows) or nmloc (linux). If this file is not found, it looks in the top directory of the NONMEM installed directory. Thus, the file nmloc.bat (Windows) or nmloc (Linux) in the top nonmem installed directory serves as the default location file, and may be modified, or used as a template and placed in the working directory or specified in the –locfile option on the command line. If a particular environment variable in the above list is not found or is not defined, then nmfe7x will behave as in earlier versions, and rely on the presently existing PATH for finding the compiler and MPI system. The nmfe7x script will display a statement as to what path it will use.

The following applies to the experimental library release. See NONMEM Installation Guide for traditional installation instructions.

NONMEM is also available as pre-compiled executibles and libraries. This experimental features requires cmake and ninja build tools. User can choose according to OS and gfortran compiler version when downloading NONMEM.

1

  set PATH=C:\path\to\winlibs\mingw64\bin;%PATH%

1

  setx PATH "%PATH%;C:\path\to\winlibs\mingw64\bin"

1

  set PATH=C:\Program Files\Microsoft MPI\Bin;%PATH%

1
2
3
4
5

  sudo apt update
  sudo apt install gcc
  sudo apt install gfortran
  sudo apt install cmake
  sudo apt install ninja-build

1

  xcode-select --install

1

  brew install gcc

1
2

  brew install cmake
  brew install ninja

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

C:\path\to\build>nmf2.bat
Usage: nmf2.bat model_file [options]...

Options:

-licfile=: specify license path. If not set nm_dir is used.
-background: run in the background.
-prdefault: use default arrays sizes.
-tprdefault: test if '-prdefault' is applicable. If so, run with it.
-maxlim=0|1|2|3: LIM size levels for array sizes.
-nodes=: number of cores in MPI run. If given the run will assume '-parafile=LOCALNODE'.
-xmloff: turn off xml file output.
-parafprint=: iteration intervals between printing in parallel runs.
-simparon: parallelize simulations in addition to estimations.
-flushtime=: lower limit of output file update interval (seconds).
-dde: augment control stream file for delay differential equation models.
-do2test: check control stream for analytical 2nd derivatives.
-nobuild: do not build executable.
-mpi_home=: home dir of MPI library. Used by cmake to locate MPI.

1

nmf2.bat \path\to\model.ctl \path\to\output_result.res