MAOPPY

Modelization of the Adaptive Optics Psf in PYthon

Version

1.0.0

Requires

Python 3 or higher version is recommended.

MAOPPY 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 MAOPPY 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 MAOPPY folder to your PYTHONPATH.

• For Spyder users (for any OS):
  • Go to tools > manage PYTHONPATH > add path
  • Add the path up to the MAOPPY root C:\Users\...\MAOPPY
  • 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/.../MAOPPY 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 MAOPPY folder
• Temporary add MAOPPY (not recommanded). If you don't want to permanently add MAOPPY 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\MAOPPY")

Libraries are now ready to be used in your scripts with commands like from maoppy.some_module import some_function. You may also run now Jupyter tutorials to start using MAOPPY.

Content

• maoppy/
  • example/ (an example to get started)
  • __init__.py
  • config.py (configuration for MAOPPY library)
  • instrument.py (load defined optical systems)
  • psfmodel.py (parametric PSF models and fitting)
  • utils.py (frequently used functions)
• setup.py (library setup)
• README.md (this file)
• LICENSE (MAOPPY license file)

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