From 9af74d05f18c9a1cf4cb60f5e02f0fd83c51f5c2 Mon Sep 17 00:00:00 2001 From: Giacomo Acciarini Date: Tue, 5 Sep 2023 13:30:11 +0200 Subject: [PATCH] Create index.rst --- docs/source/index.rst | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 docs/source/index.rst diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..9f7ad90 --- /dev/null +++ b/docs/source/index.rst @@ -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`