Commit 0bc485a4 authored by bepinat's avatar bepinat

Update readme

parent 6390192f
# GalKin: Galaxy Kinematics
### What is it?
## What is it?
**GalKin** fits a velocity model on an observed velocity field of galaxy.
### Model
## Model
To compute the model, we use the method of line moments from:
[Epinat, B., Amram, P., Balkowski, C., & Marcelin, M. 2010, MNRAS, 401, 2113](http://adsabs.harvard.edu/abs/2010MNRAS.401.2113E)
......@@ -23,7 +23,8 @@ its installation guide.
The program also needs **astropy** and **yaml** libraries.
## How to lunch?
## How to launch the program?
**Galkin** can be launch from prompt with
```
galkin.py path filename
......@@ -51,11 +52,11 @@ mpiexec -n (nbcore) galkin.py path filename
Outputs are written in the directory where the **YAML** config file is. The name of the directory depends on the method, the model and fixed parameters like:
method_model_fixedparams. A summary of the parameters of the model is written in the header of the fits file and in a **YAML** file.
### Example
## Example
There is a Example directory in which you have fits files and a **YAML** file as example to try the program.
### Create model
## Create model
The subprocess to create map was used to validate the program (cross test) with existing programs.
This subprocess needs to be updated from the last changes of the architecture and the addition of the data language **YAML**.
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