Commit c61f353e authored by FETICK Romain's avatar FETICK Romain
Browse files

Update readme and setup

parent cc384f30
# MAOPPY
Modelization of the
Adaptive
Optics
Psf in
PYthon
**M**odelization of the
**A**daptive
**O**ptics
**P**sf in
**PY**thon
Library for parsimonious modelization of the PSF for astronomy applications.
It includes the Moffat model and the `Psfao` model ( Fétick+2019b, see full reference below) dedicated to a modelization of the AO corrected PSF.
The instruments `ZIMPOL` and `MUSE_NFM` are already implemented, but feel free to add yours. Do not hesitate to contact me (information below) if you wish to contribute and add a major instrument to MAOPPY.
A simple fitting method is provided, however you may use your own as long as you conform with the PSF models calling syntax.
## Version
1.0.0
1.1.0 (May 8th 2020)
## Requires
......@@ -16,7 +23,7 @@ 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
It is also highly recommanded to have `matplotlib` for running example scripts
## Quick start
......@@ -49,7 +56,7 @@ Libraries are now ready to be used in your scripts with commands like `from maop
## Content
* **maoppy/**
* **example/** _(an example to get started)_
* **example/** _(some examples to get started)_
* \_\_init\_\_.py
* config.py _(configuration for MAOPPY library)_
* instrument.py _(load defined optical systems)_
......@@ -61,11 +68,19 @@ Libraries are now ready to be used in your scripts with commands like `from maop
## Authors
* Romain JL. Fétick (LAM)
Romain JL. Fétick (LAM)
romain.fetick@lam.fr
Laboratoire d'Astrophysique de Marseille,
38 rue Frédéric Joliot Curie, 13388 Marseille (France)
## Reference
If you may use the `Psfao` model of this library, here is the reference
[Fétick et al., August 2019, Astronomy and Astrophysics, Vol.628](https://www.aanda.org/articles/aa/abs/2019/08/aa35830-19/aa35830-19.html)
## License
See the [LICENSE file](LICENSE.md)
......@@ -13,8 +13,8 @@ if _sys.version_info[0]<3:
_warnings.warn("MAOPPY was developped on Python 3, but your Python version is anterior. We hope everything will be fine")
# MAOPPY release version
__version__ = "1.0.0"
__version__ = "1.1.0"
__author__ = "Romain JL. Fétick (LAM, France)"
__date__ = "May 27 2019"
__date__ = "May 08 2020"
from . import config, utils, instrument, psfmodel
......@@ -302,7 +302,7 @@ class ParametricPSF(object):
raise ValueError("When defined, `keys_comment` must be same size as `param`")
hdr = fits.Header()
hdr["HIERARCH ORIGIN"] = "PAOMPY automatic header"
hdr["HIERARCH ORIGIN"] = "MAOPPY automatic header"
hdr["HIERARCH CREATION"] = (time.ctime(),"Date of file creation")
for i in range(len(param)):
if keys_comment is None:
......
......@@ -9,11 +9,12 @@ Created on Mon May 27 17:11:01 2019
from setuptools import setup, find_packages
setup(name='MAOPPY',
version='0.0.1.dev',
version='1.1.0',
url='https://gitlab.lam.fr/lam-grd-public/maoppy.git',
license='See LICENSE file',
author='Romain JL Fetick (LAM, Marseille, France)',
author_email='romain.fetick@lam.fr',
description='Modelization of the Adaptive Optics Psf in PYthon (MAOPPY)',
packages=find_packages(exclude=['examples','tests']),
zip_safe=False,
)
requires=['numpy','scipy','astropy'],
zip_safe=False)
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