-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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` |