lpjcheck(1)

NAME
lpjcheck - Checks syntax of LPJmL configuration files

SYNOPSIS
lpjcheck [-h] [-q] [-vv] [-param] [-pp cmd] [-output {write|gather|mpi2|socket=hostname[:port]}] [-outpath dir] [-inpath dir] [-restartpath dir] [[-Dmacro[=value]] [-Idir] ...] [filename]

DESCRIPTION
Program checks the syntax of LPJmL configuration files. It is checked additionally whether all input files and output directories are present. lpjcheck will print the total amount of disk space used for the output files.

OPTIONS

-h  display a short help text

-q  Only error messages are displayed, other output is suppressed.

-vv verbosely print the actual values during reading of the configuration files.

-param
    Print LPJmL parameter.

-pp cmd
    Set preprocessor program to cmd. Default is cpp -P.

-output {gather|mpi2|socket=hostname[:port]}
    use the given output method to write data to disk. Valid output methods are write, mpi2, gather, and socket. The default output method for the MPI version is gather sending all output to the root task, while the default method for the sequential code is write. The methods gather and mpi2 are only valid for the MPI version of the code.

-outpath dir
    set the output directory path. The path is added to the output filenames if they do not contain an absolute path.

-inpath dir
    set the input directory path. The path is added to the input filenames if they do not contain an absolute path.

-Dmacro[=value]
    define macro for the preprocessor of the configuration file

-Idir
    define include directory for the preprocessor of the configuration file

filename
    name of configuration file, default is lpjml.conf.

EXAMPLES

Check default configuration file with input files located in the scratch file system
    lpjcheck -input /scratch/02/lpj

ENVIRONMENT

LPJCONFIG
    default LPJmL configuration filename

LPJPREP
    defines preprocessor command for LPJmL configuration file, default is cpp -P. Same as '-pp' option.

LPJROOT
    defines the root directory for LPJmL. This directory is added to the include directories of the preprocessor

LPJINPATH
    Path appended to the input filenames. Only done for filenames without absolute path.

LPJOPTIONS
    runtime options for the preprocessor of LPJmL configuration files

LPJOUTPATH
    Path appended to the output filenames. Only done for filenames without absolute path.

LPJRESTARTPATH
    Path appended to the restart filenames. Only done for filenames without absolute path.

LPJOUTPUT
    Default method for generating output files. Valid values are write, mpi2, gather, and socket.

EXIT STATUS
lpjcheck returns a zero exit status if the configuration file has no syntax errors and all input files and output directories exist. Non zero is returned in case of failure.

AUTHOR
Werner von Bloh (Werner.von.Bloh@pik-potsdam.de)

COPYRIGHT
(C) Potsdam Institute for Climate Impact Research (PIK), see COPYRIGHT file

SEE ALSO
lpjml(1), lpjsubmit(1), lpjml.conf(5)