Examples
========

A collection of example input files and scripts using **VPLanet** that
showcase the various applications of the code. The source files for
the examples below live in the :code:`examples` folder in the top-level
directory of the :code:`VPLanet` repository.
`View them on GitHub <https://github.com/VirtualPlanetaryLaboratory/vplanet-private/tree/master/examples>`_.

.. toctree::
   :maxdepth: 1



   examples/MagmOc_Earth
   examples/HabEvapCore
   examples/HabitableZone
   examples/CassiniMulti
   examples/ParameterSweep
   examples/NBodyAtmEsc
   examples/StellarEvol
   examples/HLossTides
   examples/TidalEarth
   examples/VenusWaterLoss
   examples/BinaryTides
   examples/FfdProxCen
   examples/STEEP
   examples/AtmEscKepler-36
   examples/SS_NBody
   examples/ApseLock
   examples/VenusApproxInterior
   examples/CassiniStates
   examples/SSDistOrbDistRot
   examples/MagmOc_Trappist1g
   examples/AtmEscRegimes
   examples/IoHeat
   examples/GalaxyEffects
   examples/RadHeat
   examples/CircumbinaryOrbit
   examples/TideLock
   examples/WaterLossTides
   examples/AbioticO2
   examples/IceBelts
   examples/MagneticBraking
   examples/DampedCBP
   examples/MDwarfLuminosity
   examples/EarthClimate
   examples/EarthInterior
   examples/DiffLimWaterEscape
   examples/ChaoticResonances
   examples/LuminosityCycle
   examples/MiniNeptuneEvap
   examples/AtmEscFlareProxCen
   examples/MagmOc_GJ1132b


Broken
------

Currently broken examples in need of your help!

.. toctree::
   :maxdepth: 1