.. Kaipy documentation master file, created by
   sphinx-quickstart on Tue Jun 11 18:09:20 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Kaipy documentation!
=================================
Kaipy is a Python package for analysis and visualization of simulation
results from a scientific software package Kaiju. Kaiju includes the
`Multiscale Atmosphere-Geospace Environment (MAGE)
<https://cgs.jhuapl.edu/Models/mage.php>`_ model developed by the NASA
DRIVE `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. 

.. toctree::
   :maxdepth: 4
   :caption: Kaipy:
   
   kaipy/installation
   kaipy/requirements
   kaipy/usage
   scripts
   package
   kaipy/developers



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`