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 for installation instructions. Report any issues or bugs on the GitHub Issues page.

Contents:

• Example Usage
• Module Reference
  • select_device()
  • MsComplex
    • MsComplex.asc()
    • MsComplex.asc_geom()
    • MsComplex.canc_pairs()
    • MsComplex.collect_geom()
    • MsComplex.compute_arr()
    • MsComplex.compute_bin()
    • MsComplex.cp_cellid()
    • MsComplex.cp_detail_string()
    • MsComplex.cp_func()
    • MsComplex.cp_index()
    • MsComplex.cp_pairid()
    • MsComplex.cp_vertid()
    • MsComplex.cps()
    • MsComplex.cps_cellid()
    • MsComplex.cps_func()
    • MsComplex.cps_index()
    • MsComplex.cps_pairid()
    • MsComplex.cps_vertid()
    • MsComplex.dbg_serialize()
    • MsComplex.des()
    • MsComplex.des_geom()
    • MsComplex.dual_points()
    • MsComplex.load()
    • MsComplex.num_cps()
    • MsComplex.primal_points()
    • MsComplex.save()
    • MsComplex.simplify_pers()
    • MsComplex.vert_func()
    • MsComplex.vert_funcs()