Usage
=====

Installation
------------

To use NEMESISPY, first clone the `GitHub repository <https://github.com/Jingxuan97/nemesispy>`_
to your computer. Then, navigate to the directory where you have saved the
repository and run the command

.. code-block:: console

    $ pip install .

This will install the package and make it available to use in your Python environment.
In order to install the package but still make it editable, run instead the command

.. code-block:: console

    $ pip install . --editable

NEMESISPY can also by direcly installed from `PyPI <https://pypi.org/project/nemesispy/>`_
by running

.. code-block:: console

    $ pip install nemesispy

We recommend installing the package from the GitHub repository
to make sure that you have the latest version of the package.

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

NEMESISPY requires opacity data to be provided in the NEMESIS .kta format,
which can be obtained from the `ExoMol database <https://www.exomol.com/data/data-types/opacity/>`_.
In addition, the `Exo_k <https://perso.astrophy.u-bordeaux.fr/~jleconte/exo_k-doc/index.html>`_
package provides many helpful routines for working with opacity data.

Issues and contributions
------------------------
To report issues or problems with NEMESISPY, please use the `GitHub issue tracker <https://github.com/Jingxuan97/nemesispy>`_.
If you would like to contribute to the development of NEMESISPY, or seek scientific
collaboration, please directly `contact us  <https://www.physics.ox.ac.uk/our-people/yangj>`_.