.. edafos documentation master file, created by
   sphinx-quickstart on Mon Feb  5 07:38:47 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


.. .. image:: _static/edafos.png
   :scale: 33 %
   :alt: edafos
   :align: left
   :target: http://edafos.io


============
[``edafos``]
============


Welcome to the detailed documentation of the Python module ``edafos``, the
most comprehensive suite of Soil Mechanics algorithms.

The name, **edafos**, comes from the similarly pronounced greek word which
translates to *"The upper layer of the Earth's crust"*.

The first version of this module focuses on the design of Deep Foundations,
given that the `author`_'s doctoral dissertation is in driven piles.

Use the table of contents to navigate.

.. _author: https://www.linkedin.com/in/nmachairas/

|



Introduction
------------

.. topic:: Contents of this Section

   Add text...


.. toctree::
   :caption: INTRODUCTION:
   :maxdepth: 2

   intro/units
   intro/nomenclature




Soil Profile
------------

.. topic:: Contents of this Section

   Add text...


.. toctree::
   :maxdepth: 3
   :caption: SOIL PROFILE:

   soil/delineation
   soil/correlations
   soil/stresses




Deep Foundations
----------------

.. topic:: Contents of this Section

   Add text...


.. toctree::
   :maxdepth: 3
   :caption: DEEP FOUNDATIONS:

   deepfoundations/types_o_piles
   deepfoundations/capacity




Examples
--------

.. topic:: Contents of this Section

   Add text...


.. toctree::
   :maxdepth: 3
   :caption: EXAMPLES:

   examples/pile_capacity




API Reference
-------------

.. topic:: Contents of this Section

   This section provides the complete API reference for ``edafos``,
   auto-generated from the docstrings in the project source code.


.. toctree::
   :maxdepth: 3
   :caption: API REFERENCE:

   api/api_reference

Indices and tables
------------------

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