:html_theme.sidebar_primary.remove:

************
Installation
************

To install kosmatau3d, download the git repo, then simply install using,

.. code:: console
   
   $ pip install ./kosmatau3d

This will install kosmatau3d and most of its dependencies. 
There are a couple of packages that will not be installed, such as 
:code:`healpy`.
It is only used in the :mod:`comparison` submodule, which is used to 
process observation files and compare with the synthetic observations from 
kosmatau3d [#f1]_.
You will need to install these or similar packages to use this submodule.
:code:`healpy` is the python port of the well-kown and maintained HEALPix code.
It only installs well in a Linux environment, so that is why it is not a 
strict dependency.
Ideally the user is in a linux environment, so downloading this dependency is 
not an issue.

.. rubric:: Footnotes

.. [#f1]

   This submodule anyways senseless outside of the application of 
   :code:`kosmatau3d` to model the Galactic cooling lines.