.. pyHarm documentation master file, created by
   sphinx-quickstart on Thu Jan 25 18:00:07 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. toctree::
   :maxdepth: 2
   :caption: Table of Contents

   api_links

Description of modules & subpackages
====================================

pyHarm is composed of multiple modules and subpackages. A user guide for the different modules and packages is provided in the links below : 

.. toctree::
   :maxdepth: 1

   Module
   Systems
   Substructures
   Elements
   KinematicConditions
   NonLinearSolver
   Analysis
   Correctors
   Predictors
   Reductors
   StepSizeRules
   StopCriterion


.. include:: ./_source/QuickWalkThrough.md
   :parser: myst_parser.sphinx_


Some of the pyHarm coding philosophy
====================================

.. include:: ./_source/PhilosophyCoding.md
   :parser: myst_parser.sphinx_

   
.. rubric:: API links

:py:mod:`pyHarm`