Commit d523716f authored by rfetick's avatar rfetick
Browse files

update documentation

parent c64a7edb
......@@ -47,25 +47,6 @@ It is also highly recommanded to have `matplotlib` for running example scripts
* 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`.
## Content
* **maoppy/**
* **example/** _(some examples to get started)_
* **test/** _(unitary tests of the code)_
* \_\_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
......@@ -79,7 +60,7 @@ Laboratoire d'Astrophysique de Marseille
## Reference
If you may use the `Psfao` model of this library, here is the reference
If you may use the `Psfao` model of this library, the reference is
[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)
......
No preview for this file type
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