.. cfm-leapfrog documentation master file, created by
   sphinx-quickstart on Tue Sep 20 15:08:49 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to cfm-leapfrog's documentation!
========================================
This module is designed to help create 3D models of complex fault systems, and works by projecting surface traces to depth.
Leapfrog software should be used for mesh cutting operations.

.. image:: help/images/fault_model.png
   :width: 400
   :alt: 3D fault model of central Aotearoa New Zealand

.. toctree::
   :maxdepth: 2
   :caption: Introduction and Setup:

   help/intro.md
   help/preparation.md
   help/install.md
   help/running_examples.md

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

   tutorials/define_connected.ipynb

.. toctree::
   :maxdepth: 2
   :caption: Meshing in Leapfrog:

   help/camilla.md

.. toctree::
   :maxdepth: 2
   :caption: Python Examples (Japanese):

   tutorials/define_connected_japanese.ipynb

.. toctree::
   :maxdepth: 4
   :caption: API Reference:


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`