Update README.md

README.md

@@ -1,12 +1,11 @@
---------------------------------------------------------------------------------
+
 # **The AMUN Code**
-## Copyright (C) 2008-2019 Grzegorz Kowal ##
---------------------------------------------------------------------------------
+## Copyright (C) 2008-2019 Grzegorz Kowal
 
 AMUN is a parallel code to perform numerical simulations in fluid approximation
 on uniform or non-uniform (adaptive) meshes. The goal in developing this code is
 to create a solid framework for simulations with support for number of numerical
-methods which can be selected in an easy way through the parameter file. The
+methods which can be selected in an easy way through a parameter file. The
 following features are already implemented:
 
 * hydrodynamic and magnetohydrodynamic set of equations (HD and MHD),
@@ -18,11 +17,13 @@ following features are already implemented:
 * 2nd order TVD interpolation with number of limiters and higher order
   reconstructions,
 * Riemann solvers of Roe- and HLL-types (HLL, HLLC, and HLLD),
-* periodic and open boundary conditions,
+* standard boundary conditions: periodic, open, reflective, hydrostatic, etc.
 * viscous and resistive source terms,
+* suppor for passive scalars (up to 100),
 * data stored in the HDF5 format,
 * MPI parallelization,
-* completely written in Fortran 2003.
+* completely written in Fortran 2003,
+* Python interface to read data.
 
 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
@@ -46,12 +47,16 @@ Developers
 Requirements
 ============
 
-* Fortran 2003 compiler (tested compilers include
-  [GNU Fortran](http://gcc.gnu.org/fortran/) version 4.5 or newer,
-  [Intel Fortran](https://software.intel.com/en-us/fortran-compilers) compiler
-  version 9.0 or newer)
-* [HDF5 libraries](http://www.hdfgroup.org/HDF5/) version 1.8 or newer.
-* [OpenMPI](https://www.open-mpi.org/) version 1.8 or newer for parallel runs.
+* Fortran 2003 compiler, tested compilers include:
+    - [GNU Fortran](https://gcc.gnu.org/fortran/) version 4.5 or newer,
+    - [PGI Community Edition](https://www.pgroup.com/products/community.htm),
+      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.8 or newer.
+* [OpenMPI](https://www.open-mpi.org/) for parallel runs, tested with version
+  1.8 or newer.
 
 
 Environment Variables
@@ -65,11 +70,15 @@ the HDF5 libraries have been installed.
 
 Compilation
 ===========
-1. Clone the AMUN source code: `git clone https://bitbucket.org/amunteam/amun-code.git`,
-   or unpack the archive downloaded from page
+1. Clone the AMUN source code:
+  - from Bitbucket:
+    `git clone https://grzegorz_kowal@bitbucket.org/amunteam/amun-code.git`,
+  - from GitLab:
+    `git clone https://gitlab.com/gkowal/amun-code.git`
+  - or unpack the archive downloaded from page
    [Downloads](https://bitbucket.org/amunteam/amun-code/downloads/).
 2. Go to directory **build/hosts/** and copy file **default** to a new file named
-   exactly as your host name (name returned by command `hostname`).
+   exactly as your host name, i.e. `cp default $HOSTNAME`.
 3. Customize your compiler and compilation options in your new host file.
 4. Go up to directory **build/** and copy file **make.default** to **make.config**.
 5. Customize compilation time options in **make.config**.
@@ -80,16 +89,18 @@ Compilation
 Usage
 =====
 
-In order to run some test problems you can simply copy corresponding parameter
-from directory **problems/** to the location when you wish to run your test.
-Copy the executable file **amun.x** compiled earlier to the same directory. If
-you provide option _-i <parameter_file>_, the code will know that the parameters
-have to be read from file _<parameter_file>_. If you don't provide this option,
-the code will assume that the parameters are stored in file **params.in** in the
-same director.
+In order to run some test problems you can simply copy the problem parameter
+file from directory **problems/** to the location where you wish to run your
+test. Copy the executable file **amun.x** from the **build/** directory compiled
+earlier. If you provide option _-i <parameter_file>_, the code will know that
+parameters have to be read from file _<parameter_file>_. If you don't provide
+this option, the code assumes that the parameters are stored in file
+**params.in** in the same director.
 
-In order to run serial version, type in your terminal:  `amun.x -i params.in`.
+In order to run serial version, just type in your terminal:
+  `./amun.x -i ./params.in`.
 
-In order to run the parallel version (after compiling the code with MPI
-version), type in your terminal: `mpirun -n N ./amun.x -i params.in`, where N is
-the number of processors.
+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.