Commit 6390192f authored by bepinat's avatar bepinat

Update readme

parent 800040fa
......@@ -5,31 +5,30 @@
### Model
For compute the model, we use method of moments from:
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)
But you can add more rotational curves in "velocity_model.py" or create another model like cube etc.
But one can add more rotational curves in "velocity_model.py" or create another model like cube etc.
### There is two methods implemented
### There are two methods implemented
- MPFIT: Which uses the Levenberg-Marquardt technique to solve the
least-squares problem.
- MPFIT: which uses the Levenberg-Marquardt technique to solve the least-squares problem.
- PyMultiNest : use a Nested Sampling Monte Carlo library and bayesian statistics.
- PyMultiNest : which uses a Nested Sampling Monte Carlo library and bayesian statistics.
## Installation
The program need PyMultiNest installed, please refer to [this link](https://johannesbuchner.github.io/PyMultiNest/) for
The program needs PyMultiNest to be installed, please refer to [this link](https://johannesbuchner.github.io/PyMultiNest/) for
its installation guide.
The program need also **astropy** and **yaml** libraries.
The program also needs **astropy** and **yaml** libraries.
## How to lunch?
**Galkin** can be lunch from prompt with
**Galkin** can be launch from prompt with
```
galkin.py path filename
```
or in an python script/console by importing first and call the main function
or in a python script/console by importing first **galkin** and then calling the main function
```
import galkin.py
......@@ -37,24 +36,26 @@ galkin.galkin(path, filename, rank=0)
```
where path can be absolute or relative, filename is the name of the **YAML** configuration file. The parameter rank is the id of the thread.
Example if you run the program with mpi and 4 core, rank may be equal from 0 to 3.
For example, if you run the program with mpi and 4 core, rank may be equal from 0 to 3.
### Compatible with MPI4PY
For more information and how to install it, follow<a href="http://pythonhosted.org/mpi4py/"> this link<a/>.
For more information and how to install it, follow [this link](http://pythonhosted.org/mpi4py/).
To execute the program with **mpi4py**:
```
mpiexec -n (nbcore) galkin.py path filename
```
## Output
Outputs are written in a directory where the **YAML** config file is. The name of the directory depend of the method, the model and fixed paramters like:
method_model_fixedparams. A recapitulation of parameters of the model is written in the header of fits file and in a **YAML** file.
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
There is a Example directory in which you have fits files and a **YAML** file as example and try the program.
There is a Example directory in which you have fits files and a **YAML** file as example to try the program.
### Create model
The subprocess for create map was used to validate the program (cross test) with existing programs.
This subprocess need to be updated from the last changes of the architecture and the addition of the data language **YAML**.
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