Changes
Page history
mozul created page: compilation
authored
Dec 19, 2016
by
Rémy Mozul
Show whitespace changes
Inline
Side-by-side
first_steps.markdown
View page @
553ff202
# Getting started #
# First steps #
There are several examples in the directory
*examples*
sorted by the type of simulation.
LMGC90 software main API is a Python module. It come with a pre-processor written in Python.
## Tutorials ##
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.
### Linux ###
To read the notebooks, open a terminal there and run:
```
shell
jupyter notebook
```
### MacOS ###
To read the notebooks, open a terminal there and run:
```
shell
jupyter-notebook-2.7
```
### Wndows ###
To read the notebooks run the
`Jupyter Notebook`
application installed with Anaconda.
## Use of Python ##
Python being the interface language to the LMGC90 software,
[
this introduction
](
http://www.scipy-lectures.org/index.html
)
is recommended for those unfamiliar with the language or programming in general.
# Running generic example #
LMGC90 software main API is a Python module. It comes with a pre-processor written in Python.
There are several examples in the
*examples*
directory of the user version. Follow the next
There are several examples in the
*examples*
directory of the user version. Follow the next
steps to run one of them.
steps to run one of them.
...
@@ -9,7 +42,8 @@ First choose an example and open a terminal in the directory of the example.
...
@@ -9,7 +42,8 @@ First choose an example and open a terminal in the directory of the example.
### Generation ###
### Generation ###
To have more information on the pre-processor open in a web navigator the file
*docs/pre_lmgc/index.html*
.
To have more information on the pre-processor open in a web navigator the file
[
*docs/pre_lmgc/index.html*
](
http://www.lmgc.univ-montp2.fr/~dubois/LMGC90/UserDoc/pre/index.html
)
.
To run an example, if there is no DATBOX directory or it is empty, run the Python generation script which
To run an example, if there is no DATBOX directory or it is empty, run the Python generation script which
is most time called
*gen_sample.py*
with the command:
is most time called
*gen_sample.py*
with the command:
...
@@ -27,10 +61,11 @@ $> python command.py
...
@@ -27,10 +61,11 @@ $> python command.py
```
```
To get more information on the structure on command scripts read the documentation opening the file
To get more information on the structure on command scripts read the documentation opening the file
*docs/chipy/index.html*
in a web navigator.
[
*docs/chipy/index.html*
](
http://www.lmgc.univ-montp2.fr/%7Edubois/LMGC90/UserDoc/chipy/index.html
)
in a web browser.
Once the computation is done, you should have the directory
*OUTBOX*
containing ASCII output files,
and a
Once the computation is done, you should have the directory
*OUTBOX*
containing ASCII output files,
*DISPLAY*
directory with output file readable by paraview.
and a
*DISPLAY*
directory with output file readable by paraview.
### Postprocessing and Visualization ###
### Postprocessing and Visualization ###
...
...
...
...