.. Stoneforge documentation master file, created by
   sphinx-quickstart on Mon May 27 13:42:11 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Stoneforge's documentation!
======================================

**Version**: 1.4

**Stoneforge** is a Python library for geophysics equations, algorithms and methods that also,
are used in the software Appy. It is linked to the GIEACAR laboratory at the Universidade Federal
Fluminense (UFF) related to the Geology and Geophysics Departament (GGO), and its purpose is to teach
and develop routines in Python to solve geological and geophysical problems.

.. note::
   This project is under active development as of May 2024.

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

   usage/installation
   usage/quickstart

   modules/petrophysics
   modules/rockphysics
   modules/pseudowells
   modules/machinelearning
   modules/preprocessing
   modules/tvdss


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

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