.. pyrootmemo documentation master file, created by
   sphinx-quickstart on Tue Jun 10 10:10:37 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

pyrootmemo
==========

Welcome to the `pyrootmemo` documentation! This project is designed to help you to estimate contribution of roots to the shear strength of soil using various models. The documentation is structured to provide a comprehensive guide to using the library, including installation, quickstart, theoretical background, and detailed explanations of the available models. `pyrootmemo` is designed using Object-Oriented Programming (OOP) principles, making it easy to extend and customize for your specific needs.

.. note::
   This documentation is a work in progress. If you have any suggestions or find any issues, please feel free to :ref:`contribute <sec-contribute>` !

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   Home <self>
   quickstart
   theory
   materials/index
   models/index
   geometry/index
   contribute