Added a function to save all fields in signe phase flows

[tools/solverlab.git] / README.md

diff --git a/README.md b/README.md
index 494e4ce4478bca2f5db5892aeb51c2b732d67fd2..9fff18e70b514c59ad88a079652766129149dbb7 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,10 @@
-SOLVERLAB
-======
+</center>
 
+| ![logo](logoSOLVERLAB.png) |
+|:--:|
+| *SOLVERLAB* |
+
+</center>
 SOLVERLAB is a geometrical and numerical C++/Python library designed for numerical analysts who work on the discretisation of partial differential equations on general shapes and meshes and would rather focus on high-level scripting. The goal is to provide simple MATLAB style functions for the generation and manipulation of meshes, fields and matrices. The library originates from [CDMATH](http://cdmath.jimdo.com), a collaborative workgroup with the same name. It is based on the [MEDcoupling](https://docs.salome-platform.org/latest/dev/MEDCoupling/tutorial/index.html) C++/python library of the [SALOME](http://www.salome-platform.org/) project for the handling of meshes and fields, and on the C++ library [PETSC](https://www.mcs.anl.gov/petsc/) for the handling of matrices and linear solvers. 
 
 SOLVERLAB includes PDE systems
@@ -23,7 +27,7 @@ The library is currently developed for linux distributions and is maintained on
 Examples of use
 ---------------
 - [Examples of stable numerical methods for the 1D linear transport equation](CDMATH/tests/doc/1DTransportEquation/RegularGrid/TransportEquation1D_RegularGrid.ipynb)
-- [Shock formation and numerical capture issues for the 1D Burgers' equations](tests/doc/1DBurgersEquation/BurgersEquation1D.ipynb)
+- [Shock formation and numerical capture issues for the 1D Burgers' equations](CDMATH/tests/doc/1DBurgersEquation/BurgersEquation1D.ipynb)
 - [Influence of the mesh on the convergence and low Mach precision for the UPWIND finite volume method applied to the 2D wave system](CDMATH/tests/doc/2DWaveSystemVF_stationary/Convergence_WaveSystem_Upwind_SQUARE.ipynb)
 - [Influence of the mesh on the convergence and low Mach precision  for the CENTERED finite volume method applied to the 2D wave system](CDMATH/tests/doc/2DWaveSystemVF_stationary/Convergence_WaveSystem_Centered_SQUARE.ipynb)
 - [Influence of the mesh on the convergence and low Mach precision  for the STAGGERED finite volume method applied to the 2D wave system](CDMATH/tests/doc/2DWaveSystemVF_stationary/Convergence_WaveSystem_Staggered_SQUARE_squares.ipynb)
@@ -41,7 +45,7 @@ Create your source directory. For instance:
 * `cd ~/workspace/SOLVERLAB`
 
 Download from salome-platform.org
-* clone the git repository to a folder SOLVERLAB-master:  `git clone http://git.salome-platform.org/gitpub/modules/SolverLab.git SOLVERLAB-master`
+* clone the git repository to a folder SOLVERLAB-master:  `git clone http://git.salome-platform.org/gitpub/modules/solverlab.git SOLVERLAB-master`
 
 
 Set the environment for the compilation of SOLVERLAB
@@ -52,6 +56,7 @@ Dependencies. The following package list is sufficient on Ubuntu 14.04, Ubuntu 1
  - `g++` or another C++ compiler (mandatory)
  - `python-dev`, `python-numpy` and `swig3`for python scripts (mandatory)
  - `python-matplotlib` and `paraview` for postprocessing tools such as plotting curves (matplotlib) or generating 3D view images (paraview) (mandatory)
+ - `ffmpeg` and `ffmpeg-devel` to generate an animation from a set of curves (optional)
  - `doxygen`, `graphviz` and `mscgen`, if you want to generate a nice source code documentation in `~/workspace/SOLVERLAB/SOLVERLAB_install/share/doc/`. Use the compilation option `-DSOLVERLAB_WITH_DOCUMENTATION=ON` (optional).
  - `libcppunit-dev`, if you want to generate unit tests. Use the compilation option `-DSOLVERLAB_WITH_TESTS=ON` (optional).
  - `rpm`, if you want to generate RPM installation packages. Use the compilation option `-DSOLVERLAB_WITH_PACKAGE=ON` (optional).