.. Geometrically exact string documentation master file, created by
   sphinx-quickstart on Wed Jul  6 15:41:00 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

===========================================
Documentation of 'GeometricallyExactString' 
===========================================

`GeometricallyExactString <https://github.com/THREAD-3-2/GeometricallyExactString>`_ is a Python code for a geometrically exact string with fixed-free boundary conditions.
It uses `Jax <https://jax.readthedocs.io/en/latest/>`_ for automatic differentiation and just-in-time compilation capabilities.
The method used is part of ongoing research. 

Contents
--------

.. toctree::
   installation
   example
   geometricallyexactstring
   plotting
   :maxdepth: 2


Indices and tables
------------------

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