From 775537cecfdc5a87bebfa67215e139a98b7ca0fa Mon Sep 17 00:00:00 2001
From: Grzegorz Kowal <grzegorz@amuncode.org>
Date: Fri, 1 May 2020 15:24:01 -0300
Subject: [PATCH] Update README
Signed-off-by: Grzegorz Kowal <grzegorz@amuncode.org>
---
README.md | 21 +++++++++++++--------
1 file changed, 13 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 26d0e7c..4e80d43 100644
--- a/README.md
+++ b/README.md
@@ -18,12 +18,15 @@ following features are already implemented:
reconstructions,
* Riemann solvers of Roe- and HLL-types (HLL, HLLC, and HLLD),
* standard boundary conditions: periodic, open, reflective, hydrostatic, etc.
+* turbulence driving using Alvelius or Ornstein–Uhlenbeck methods,
* viscous and resistive source terms,
-* suppor for passive scalars (up to 100),
-* data stored in the HDF5 format,
+* support for passive scalars (up to 100),
+* data stored in internal XML+binary or HDF5 format,
+* Python interface to read snapshots in both formats,
* MPI parallelization,
* completely written in Fortran 2003,
-* Python interface to read data.
+* minimum requirements, only Fortran compiler and Python are required to
+ prepare, run, and analyze your simulations.
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
@@ -53,10 +56,12 @@ Requirements
version 18.10 or newer,
- [Intel Fortran](https://software.intel.com/en-us/fortran-compilers)
compiler version 9.0 or newer.
-* [HDF5 libraries](https://www.hdfgroup.org/solutions/hdf5/), tested with
- version 1.10 or newer.
-* [OpenMPI](https://www.open-mpi.org/) for parallel runs, tested with version
- 1.8 or newer.
+* Optional, but recommended, [OpenMPI](https://www.open-mpi.org/) for parallel
+ runs, tested with version 1.8 or newer.
+* Optional [HDF5 libraries](https://www.hdfgroup.org/solutions/hdf5/), tested
+ with version 1.10 or newer. The code now uses the new XML-binary snapshot
+ format. However, if you still wants to use older HDF5 snapshot format, you
+ will need these libraries.
Environment Variables
@@ -103,4 +108,4 @@ In order to run serial version, just type in your terminal:
In order to run parallel version (after compiling the code with MPI support),
type in your terminal:
`mpirun -n N ./amun.x -i ./params.in`,
-where N is the number of processors to use.
\ No newline at end of file
+where N is the number of processors to use.