Commit baa78490 authored by Natalja Rakowsky's avatar Natalja Rakowsky
Browse files

Update README.md

parent ef033e5f
The TsunAWI source code
=======================
Requirements
----------------
* Fortran compiler supporting Fortran 2013, e.g., GNU gfortran, Intel ifort.
Documentation
---------------
Optional:
* OpenMP
* netcdf
For documentation, please refer to [https://tsunami.awi.de](https://tsunami.awi.de).
You can find information on the numerical implementation of the non-linear shallow water
equations, on input fields and parameters, on the output options, and in particular on:
Installation
------------
**1. The old fashioned way**
```
cd src
```
choose a Makefile.in_*, copy to Makefile.in, adjust to your system (compiler, flags, path to netcdf).
* [Installation](https://tsunami.awi.de/installation.html#installation)
* [History incl. funding](https://tsunami.awi.de/theory/Introduction.html)
If desired, set -DNO_NETCDF and/or -DNO_FOXY in Makefile.in to switch off netcdf and/or XML (libfoxy) support.
```
make
```
**2. cmake**
Test cases
------------
```
mkdir build
cd build
cmake ..
make
```
Options:
* Switch off netcdf (default:on) with -DNETCDF=OFF
* Switch on xml support with libfoxy (default:off) with -DFOXY=ON
* Increase floating point arithmetic (default:real32) with -DUSE_FLOATING_PRECISION=real64
For example:
```
cmake -DNETCDF=OFF -DFOXY=ON -DUSE_FLOATING_PRECISION=real64 ..
```
A few small test cases are available:
[https://gitlab.awi.de/tsunawi/verification](https://gitlab.awi.de/tsunawi/verification)
\ No newline at end of file
Markdown is supported
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