Commit 26982066 authored by mozul's avatar mozul

fd fix in README

parent 25e8216f
......@@ -10,16 +10,19 @@ To get the project please check [here](https://git-xen.lmgc.univ-montp2.fr/lmgc9
# Organization
In the *lmgc90_user* directory is organized in several
In *lmgc90_user* directory is organized in several
subdirectories:
* src : the sources of LMGC90 software
* examples : the user examples working with the sources
* manuals : a list of manuals/documentation for the software in pdf format
* docs : the html documentation generated from the sources
* *src* : the sources of LMGC90 software
* *examples* : the user examples working with the sources
* *manuals* : a list of manuals/documentation for the software in pdf format
* *docs* : the html documentation generated from the sources
The software is originally designed for [Linux or MacOS](#linversion)
# Linux and MacOS version
For Windows user, jump to [Windows Version section](#winversion)
# <a name="linversion"> Linux and MacOS version </a>
With MacOS and Linux the installation and use of LMGC90 software is through
the use of the terminal. You must know how to open a terminal in a specific
......@@ -45,11 +48,11 @@ $> git pull origin 2016.rc4
To compile you need:
* A fortran compiler (GNU, Intel or PGI)
* A Fortran compiler (GNU, Intel or PGI)
* Lapack library
* CMake
* Swig
* Python and numpy
* Python and Numpy
For visualisation:
......@@ -118,7 +121,7 @@ yum install git cmake gcc gcc-c++ gcc-gfortran lapack-devel swig python-devel nu
```
To visualize, some extra packages, not provided by the standard package repository, are
needed. Thus anextra repository must be added before installing the dependencies:
needed. Thus an extra repository must be added before installing the dependencies:
```
yum install epel-release
......@@ -168,7 +171,7 @@ You have several commands to run. If you are not familiar with the terminal and
please read the output of each command carefully. And if an error occurs do not blindly run the next
commands, but try to correct it first.
In the `lmgc90\_user` directory run:
In the *lmgc90_user* directory run:
```shell
mkdir build
......@@ -196,10 +199,10 @@ fi
## Getting started
There a several examples in the directory `examples`
There are several examples in the directory *examples*
sorted by the type of simulation.
A good entry point is the `Tutorial` directory where you
A good entry point is the *Tutorials* directory where you
can find some **ipython notebooks** trying to introduce
step by step the use of the software.
......@@ -221,20 +224,21 @@ jupyter-notebook-2.7
Python being the interface language to the LMGC90 software,
[this introduction](https://www.python.org/about/gettingstarted/)
is recommended for those unfamilliar with the language or programming
is recommended for those unfamiliar with the language or programming
in general.
# Windows version
# <a name=winversion> Windows version </a>
## Prerequisite
The only pre-requisite to use LMGC90 on Windows is the Python distribution used.
A binary build is provided to work only with a specific the Anaconda Python Disbritubion
which can be downloaded from [here](https://repo.continuum.io/archive/.winzip/Anaconda2-2.5.0-Windows-x86.zip). Once the file downloaded, unzip it and run the installer.
A binary build is provided to work with the Anaconda python distribution
which can be downloaded from [here](https://repo.continuum.io/archive/.winzip/Anaconda2-2.5.0-Windows-x86.zip).
Once the file downloaded, unzip it and run the installer.
To generate visualization files the **vtk** python module must be added. To do that
launch the `cmd` software and type:
launch the `Anaconda Prompt` software and type:
```shell
conda install vtk
......@@ -245,23 +249,23 @@ is also needed.
## Getting the pre-compiled version
Donwload the pre-compiled version of LMGC90 for Windows
Download the pre-compiled version of LMGC90 for Windows
[here](https://mycore.core-cloud.net/public.php?service=files&t=9525fc1c270aaddf7e8eae96214f4b49).
Then create a directory `build` in your `lmgc90\_user` directory and unzip
Then create a directory *build* in your *lmgc90_user* directory and unzip
the download file there.
## Installation
Start `Spyder` then clic on the upper line `tools` and `PYTHONPATH manager`.
Then clic `Add a path` on lower left corner and select the path to the directory
Start `Spyder` then click on the upper line `tools` and `PYTHONPATH manager`.
Then click `Add a path` on lower left corner and select the path to the directory
previously unzipped (that is in this README: *lmgc90_user/build*).
## Getting started
There a several examples in the directory `examples`
There are several examples in the directory *examples*
sorted by the type of simulation.
A good entry point is the `Tutorial` directory where you
A good entry point is the *Tutorials* directory where you
can find some **ipython notebooks** trying to introduce
step by step the use of the software.
......@@ -270,6 +274,6 @@ installed with Anaconda.
Python being the interface language to the LMGC90 software,
[this introduction](https://www.python.org/about/gettingstarted/)
is recommended for those unfamilliar with the language or programming
is recommended for those unfamiliar with the language or programming
in general.
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