.. sympyhelpers documentation master file, created by
   sphinx-quickstart on Fri Apr 18 15:14:38 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

sympyhelpers 
==========================
``sympyhelpers`` provides helper routines and definitions for ``sympy``. In particular, these methods wrap existing ``sympy`` functionality to do Newton-Euler and Lagrangian mechanics using Kane-style and Newton notation and format the outputs to match (some of) the conventions used in various textbooks including Kasdin & Paley (2011).

Installation
----------------

To install from PyPI: ::

    pip install sympyhelpers


To install from source, clone or download the code repository, and, in the top level directory run: ::

    pip install .

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

   conventions
   usage
   Notebooks/spherical_pendulum
   modules

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

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