.. TMDSimPy documentation master file, created by
   sphinx-quickstart on Sat Jun  8 12:09:21 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to TMDSimPy's documentation!
====================================

**TMDSimPy** (Tribomechadynamics Simulations for Python) is a Pyton library for solving for various tribomechadynamics problems.
Such problems can include nonlinear vibration, contact, and friction.


.. toctree::
   :maxdepth: -1
   :caption: Contents:


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

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

Contents
--------
.. toctree::
   :maxdepth: 4

   usage
   api