API reference
=============

Modules are listed from the case description and simulation inward to the
physics kernels. All quantities are SI unless a name says otherwise.

.. contents:: Modules
   :local:
   :depth: 1

DrillPyze
---------
.. automodule:: DrillPyze
   :no-members:

Case files and builder (``config``)
-----------------------------------
.. automodule:: DrillPyze.config

Simulation (``simulation``)
---------------------------
.. automodule:: DrillPyze.simulation

Parameters (``parameters``)
---------------------------
.. automodule:: DrillPyze.parameters

Top-drive controllers (``controllers``)
---------------------------------------
.. automodule:: DrillPyze.controllers

Time-step kernel (``kernel``)
-----------------------------
.. automodule:: DrillPyze.kernel

Well path (``survey``)
----------------------
.. automodule:: DrillPyze.survey

Wellbore and fluid (``wellbore``)
---------------------------------
.. automodule:: DrillPyze.wellbore

Drillstring (``drillstring``)
-----------------------------
.. automodule:: DrillPyze.drillstring

Cell geometry (``geometry``)
----------------------------
.. automodule:: DrillPyze.geometry

Steady torque and drag (``statics``)
------------------------------------
.. automodule:: DrillPyze.statics

Hydraulics (``hydraulics``)
---------------------------
.. automodule:: DrillPyze.hydraulics

Wellbore temperature (``thermal``)
----------------------------------
.. automodule:: DrillPyze.thermal

Formation and rock strength (``formation``)
-------------------------------------------
.. automodule:: DrillPyze.formation

Units (``units``)
-----------------
.. automodule:: DrillPyze.units

Simulator UI server (``ui.server``)
-----------------------------------
.. automodule:: DrillPyze.ui.server