.. PyMS3D documentation master file, created by
   sphinx-quickstart on Wed Aug 27 14:32:02 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

PyMS3D documentation
====================

Introduction
----
PyMS3D is a python library for working with Morse-Smale complexes of discrete 3D scalar fields. It provides tools for constructing, simplifying, and analysing such complexes. The library is a frontend for a C++ extension module utilising OpenCL for parallel processing, making it efficient for handling large datasets. 

Installation
----
Refer to the `Repository README <https://github.com/vgl-iisc/mscomplex3d/blob/main/Readme.md>`_ for installation instructions. Report any issues or bugs on the `GitHub Issues page <https://github.com/vgl-iisc/mscomplex3d/issues>`_.

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

   example
   pyms3d_core