Getting started
===============

Once installed, Pytmosph3R can be used as a python library, that can be imported for example in a jupyter notebook (see :ref:`python_library`).

You can find a list of all the objects and their parameters in :class:`pytmosph3r`.

Opacity data
-----------------------

You can `download <https://forge.oasu.u-bordeaux.fr/amechineau/pytmosph3r-data/-/archive/minimal/pytmosph3r-data-minimal.zip>`_ an example of simple data that may be used in the jupyter tutorial (see :ref:`python_library`) using::

    wget https://forge.oasu.u-bordeaux.fr/amechineau/pytmosph3r-data/-/archive/minimal/pytmosph3r-data-minimal.zip
    unzip pytmosph3r-data-minimal.zip
    mkdir -p data
    mv pytmosph3r-data-minimal/* data/

You should then have a ``data/`` folder containing:

- ``xsec/``: cross-sections,
- ``corrk/``: correlated-k,
- ``cia/``: Collision-Induced Absorptions,
- ``aerosol/``: aerosol properties,
- ``gcm_output/``: GCM simulation examples,
-  ``chemistry/``: an example file for one of the chemistry modules (:class:`~pytmosph3r.chemistry.interpolation.InterpolationChemistry`).


If you want to use your own/more complex data, we refer you to the `documentation of exo_k <http://perso.astrophy.u-bordeaux.fr/~jleconte/exo_k-doc/where_to_find_data.html>`_ for more information on where to get it.
However, we advise you to follow the same directory structure as our example above.