.. _examples:

Examples
========

Examples are available in the pyLIMA GitHUB repository, see ref:`installation`.

Jupyter notebooks
-----------------

To run an example, you can use `Juptyer notebook <https://jupyter.org>`_

Click on examples folder :

.. figure:: _static/pyLIMA_examples_doc.jpg
    :align: center

Select one of the pyLIMA_example_*.ipynb.


Pure Python
-----------

You can also run (and edit) classic python file :

.. code-block:: python

    python pyLIMA_example_*.py


In short, here is a short description of the examples:

- `pyLIMA_example_1 <https://github.com/ebachelet/pyLIMA/blob/master/examples/pyLIMA_example_1.py>`_: tutorial on fitting
- `pyLIMA_example_2 <https://github.com/ebachelet/pyLIMA/blob/master/examples/pyLIMA_example_2.py>`_: introduction on how to change the default parameters
- `pyLIMA_example_3 <https://github.com/ebachelet/pyLIMA/blob/master/examples/pyLIMA_example_3.py>`_: introduction on simulation
- `pyLIMA_example_3b <https://github.com/ebachelet/pyLIMA/blob/master/examples/pyLIMA_example_3b.py>`_: simulation of observations from space
- `pyLIMA_example_4 <https://github.com/ebachelet/pyLIMA/blob/master/examples/pyLIMA_example_4.py>`_: implementation of user own objective function
- `pyLIMA_example_5 <https://github.com/ebachelet/pyLIMA/blob/master/examples/pyLIMA_example_5.py>`_: fitting a planetary event

Have fun!