.. image:: ../_static/pyissm_logo_med.png
   :align: center
   :width: 300px
   :alt: pyISSM Logo

pyissm Documentation
====================

Welcome to the pyISSM documentation!

.. warning::
   This is an experimental release. Documentation remains a work in progress. Some sections may be incomplete or under development.

Quick Links
-------------------
- :doc:`Overview <overview>` - A high-level introduction to pyISSM features and capabilities.
- :doc:`Installation <installation>` - Instructions for installing pyISSM.
- :doc:`Tutorials <tutorials>` - Hands-on tutorials demonstrating common pyISSM workflows.
- :doc:`API Reference <pyissm>` - Detailed API documentation for pyISSM submodules and classes.
- :doc:`Contributing Guidelines <contributing>` - How to contribute to pyISSM development and documentation.

Getting Started
-------------------

To get started with pyISSM, please refer to the :doc:`installation <installation>` guide and the :doc:`overview <overview>` section for a comprehensive introduction to the library's features and capabilities.

Tutorials
-------------------
For hands-on pyISSM tutorials, please refer to the :doc:`tutorials <tutorials>` section.


Contributing
-------------------
We welcome contributions from the community! If you're interested in contributing to pyISSM development or documentation, please check out our :doc:`contributing guidelines <contributing>`.

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

   overview
   installation
   tutorials
   pyissm
   contributing