.. _landlab:

.. module:: landlab

==========================================================
Landlab: A modular Earth Surface Dynamics modeling library
==========================================================

.. include:: ../../README.rst
  :start-after: .. start-intro
  :end-before: .. end-intro

.. toctree::
 :caption: Getting Started
 :maxdepth: 1
 :hidden:

 installation
 Tutorial notebooks <getting_started/index>
 user_guide/index

.. toctree::
 :caption: Contributing
 :maxdepth: 1
 :hidden:

 install/index
 development/index
 API Reference <reference/index>

.. toctree::
  :caption: Useful Links
  :maxdepth: 1
  :hidden:

  changes
  contact_us
  citing
  funding
  Contributors <authors>
  License <license>
  Used by <usedby>

..
  .. toctree::
     :caption: Documentation Outline
     :maxdepth: 2

     install/index
     getting_started/index
     user_guide/index
     reference/index
     development/index

..
  The most current source code is always available from our `git
  repository <https://github.com/landlab/landlab>`_.

..
  If you are interested in the state of current development, we compile
  :ref:`ongoing development <ongoing_development>`. If you are interested in
  contributing but don't know how to get started (THANK YOU!),
  we compile :ref:`desired contributions <desired_contributions>` and have a
  :ref:`page all about development <development>`.

..
  Many Jupyter notebooks exist describing use of Landlab. Find an overview
  :ref:`here <tutorials>`. A subset of these notebooks are designed specifically
  for the classroom. Information about them and how to set them up for classroom
  use is described :ref:`on this page <teaching_tutorials>`.