Skip to content

Commit

Permalink
Create index.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
Sceki authored Sep 5, 2023
1 parent 1532674 commit 9af74d0
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Karman Reference Documentation
================================

Karman is a machine learning Python package for data-driven thermospheric
density modeling. Its main goal is to improve our understanding and
modeling of thermospheric density variations due to the Sun's influence.
Furthermore, it also has the objective to provide a shared framework where
people can design, train and benchmark their own thermospheric density
models.

The documentation is currently a work in progress.

.. toctree::
:maxdepth: 1
:caption: Getting started

installation
capabilities
credits


.. toctree::
:maxdepth: 1
:caption: Tutorials

tutorials/get_started
tutorials/generate_globe_data
tutorials/plot_globe_data


.. toctree::
:maxdepth: 1
:caption: API documentation

karman package <_autosummary/karman>

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

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

0 comments on commit 9af74d0

Please sign in to comment.