gkowal/amun-code
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source 
Signed-off-by: Grzegorz Kowal <grzegorz@amuncode.org>
This commit is contained in:
Grzegorz Kowal 2020-05-01 15:24:01 -03:00
parent e86b9f7339
commit 775537cecf
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -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.
where N is the number of processors to use.