Commit 59a731c1 authored by FETICK Romain's avatar FETICK Romain
Browse files

Ajout de README.md

parent 0611816e
Pipeline #1186 canceled with stages
# PAOMPY
Psf
Adaptive
Optics
Modeling in
PYthon
## Version
1.0.0
## Requires
Python 3 or higher version is recommended.
PAOMPY requires the following packages: `numpy`, `scipy`, `astropy`
It is also highly recommanded to have `matplotlib` for running example scripts and Jupyter notebooks
## Quick start
1. Download the full PAOMPY repository to your computer using one of the two options
* Simple: Click on the ZIP download link
* Recommanded: Use GIT commands to clone the project to your machine. You are then able to collaborate with us (edit/push/pull)
2. Add the PAOMPY folder to your PYTHONPATH.
* For Spyder users (for any OS):
* Go to `tools > manage PYTHONPATH > add path`
* Add the path up to the PAOMPY root `C:\Users\...\PAOMPY`
* Close and launch again the Python environment
* Linux command lines:
* From a terminal, open the bashrc, e.g. with gedit `gedit ~/.bashrc`
* Go to the end of the file and add the lines `PYTHONPATH=$HOME/.../PAOMPY` and `export PYTHONPATH`
* Save and close the bashrc
* From the terminal run `source ~/.bashrc` to take modifications into account
* Windows environment
* Go to `Windows > System`
* Search tool `"variable"`
* Select `Modify environment variables > Environment variables`
* In the list select `PYTHONPATH` and then click on `Modify`
* Add the path to your PAOMPY folder
* Temporary add PAOMPY (not recommanded). If you don't want to permanently add PAOMPY to your `PYTHONPATH` you can manually add it each time you run Python
* Start a Python interpreter (Spyder, command line...)
* Run the Python commands `import sys` and then `sys.path.append("C:\folder\to\PAOMPY")`
Libraries are now ready to be used in your scripts with commands like `from paompy.some_module import some_function`. You may also run now Jupyter tutorials to start using PAOMPY.
## Content
* **HTML** _(modules documentation in HTML format)_
* **Jupyter tuto** _(Jupyter tutoriels to handle PAOMPY)_
* **PAOMPY**
* **data/** _(some fits files for tests)_
* **example/** _(some test examples, slightly redundant with Jupyter tuto)_
* **tests/** _(Unit tests of PAOMPY functions)_
* \_\_init\_\_.py
* config.py _(library internally used in PAOMPY)_
* instrument.py _(load defined optical systems)_
* psfmodel.py _(parametric PSF models and fitting)_
* telemetry.py _(extract telemetry data)_
* utils.py _(frequently used functions)_
## Authors
* Romain JL. Fétick (LAM)
Laboratoire d'Astrophysique de Marseille,
38 rue Frédéric Joliot Curie, 13388 Marseille (France)
## License
See the [LICENSE file](LICENSE.md)
\ No newline at end of file
Supports Markdown
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