Welcome to the ``kaiju`` documentation
======================================

This is the documentation for the ``kaiju`` software. ``kaiju`` includes the
Multiscale Atmosphere-Geospace Environment (`MAGE
<https://cgs.jhuapl.edu/Models/>`_) model developed by the `Center for
Geospace Storms <https://cgs.jhuapl.edu/>`_ as well as other scientific
software for simulation of heliospheric environments such as planetary
magnetospheres and the solar wind. This documentation focuses on
`MAGE <https://cgs.jhuapl.edu/Models/>`_ and `GAMERA-helio <https://cgs.jhuapl.edu/Models/gamera.php>`_, i.e., the geospace
and inner heliosphere applications of the ``kaiju`` software.

.. important::
    Users of any code or data from this repository are expected to respect
    these :doc:`rules of the road <roadrules>`.

If you encounter any issues or have questions, first read the
:doc:`rules of the road <roadrules>` above and then consider joining
the Slack channel we set up for the Kaiju user community. If you want
to join, send us a message with your
request `here <https://cgs.jhuapl.edu/feedback/>`_.

====================
Table of contents
====================
.. toctree::
    :maxdepth: 1

    self
    python/index
    building/index
    running/index
    makeitso/index
    tools/index
    roadrules
    misc/index

.. only:: obsolete

   Internal Docs
   -------------

   .. toctree::
      :maxdepth: 2

      _obsolete/index