# TidalPy Documentation

```{include} Overview/Readme.md
:start-after: TidalPy
:end-before: Overview
```

Please click on a page below to learn more about the package. 

Also check out the GitHub page to see the code.
[GitHub](https://github.com/jrenaud90/TidalPy)

```{toctree}
:maxdepth: 2
:caption: TidalPy

Overview <Overview/index.md>
```

```{toctree}
:maxdepth: 2
:caption: Modules

Rheology <Rheology/index.md>
RadialSolver (Love Number Calculator) <RadialSolver/index.md>
Exoplanets <Exoplanets.md>
Dynamics <Dynamics/index.md>
```

```{toctree}
:maxdepth: 2
:caption: Demos

Demos/1 - Build Planets <Demos/1_-_Build_Planets.ipynb>
Demos/2 - Thermal Exploration <Demos/2_-_Thermal_Exploration.ipynb>
Demos/3 - Calculating Love Numbers <Demos/3_-_Calculating_Love_Numbers.ipynb>
Demos/4 - Eccentricity Truncations <Demos/4_-_Eccentricity_Truncations.ipynb>
Demos/5 - Rheology Exploration <Demos/5_-_Rheology_Exploration.ipynb>
Demos/6 - Multilayer Heating <Demos/6_-_Multilayer_Heating.ipynb>
Demos/7 - Comparison of Tidal Modes <Demos/7_-_Comparison_of_Tidal_Modes.ipynb>
Demos/8 - Love Number Sensitivity <Demos/8_-_Love_Number_Sensitivity.ipynb>
```

```{toctree}
:maxdepth: 2
:caption: Auto Generated API

TidalPy API <API/index.md>
```

```{toctree}
:maxdepth: 2
:caption: Additional Info
:hidden:

Change Log <Changes.md>
```