.. _user_guide:

SimPEG User Guide
=================

This guide is aimed to help users to get started with SimPEG and to learn how
to simulate physics and run inversions for different types of geophysical data.

For details on the available classes and functions in SimPEG, please visit the
:ref:`api`.

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

  getting-started/about-simpeg.rst
  getting-started/big_picture
  getting-started/installing
  getting-started/contributing/index.rst
  getting-started/citing.rst
  getting-started/version-compatibility.rst

.. toctree::
  :glob:
  :maxdepth: 1
  :caption: How to Guide

  how-to-guide/choosing-solvers
  how-to-guide/move-mesh-to-survey.rst

.. toctree::
  :glob:
  :maxdepth: 1
  :caption: Tutorials

  tutorials/**/index

.. toctree::
  :maxdepth: 2
  :caption: Examples

  examples/index