Commit 75156f79 authored by Sebastian Müller's avatar Sebastian Müller 🐈
Browse files

doc: add usage documentation

parent cb059fa7
Pipeline #98306 passed with stages
in 21 minutes and 22 seconds
......@@ -18,6 +18,7 @@ edk_debug
edk_openmp
edk_openmp_debug
forces/
check/case_**/output/
# Exclusions
*.g90
......
......@@ -26,6 +26,22 @@ source scripts/compile
```
This will give an executable `edk`.
## Usage
To run the EDK program, you need a set of station data files, a look-up-table for these stations and a DEM file for the external drift.
All configuration is done with a namelist file, which is called `edk.nml` by default. See the example file for all input specifications.
Then you can just execute `./edk` next to this file.
You can also explicitly specify the namelist file and/or change the working directory by passing options the the `edk` command like:
```bash
./edk -n edk.nml check/case_01
```
To see the help text, execute:
```bash
./edk --help
```
## Cite as
......
......@@ -310,7 +310,8 @@ OPTIMIZE_OUTPUT_SLICE = NO
#
# Note see also the list of default file extension mappings.
EXTENSION_MAPPING = txt=md
EXTENSION_MAPPING = txt=md \
nml=Fortran
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
......@@ -864,7 +865,8 @@ WARN_LOGFILE = doxygen_warn.txt
INPUT = src/ \
app/ \
doc/ \
README.md
README.md \
edk.nml
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
......@@ -926,7 +928,8 @@ FILE_PATTERNS = *.c \
*.f \
*.for \
*.vhd \
*.vhdl
*.vhdl \
*.nml
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
......
!EDK-Grid***Main configuration file for Precipitation for GER***
!> \file edk.nml
!> \brief EDK-Grid **Main configuration file for Precipitation for GER**
&mainVars ! namelist mainpaths
! -------------------------------------------------------------------
! ----------------- INPUT SPECIFICATIONS ----------------------------
......@@ -88,7 +89,7 @@ dh = 1.0e3 ! binsize for variogram [m]
hMax = 1.5e5 ! max distance h for variogram estimation [m]
! -------------------------------------------------------------------
! --------------- NC OUTPUT SPECIFICATION ----------------------------
author_name = 'Akash Koppa'
author_name = 'mHM Developers'
projection_name = 'EPSG:4326 '
invert_y = .True. ! (set True if working with mHM input data!)
variable_name = 'pr'
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment