# API Reference


```eval_rst
Classes
-------
.. autosummary::
   :toctree: generated/
   

   pyMMF.IndexProfile
   pyMMF.propagationModeSolver
   pyMMF.Modes


Helper functions
----------------

.. autosummary::
   :toctree: generated/

   pyMMF.estimateNumModesSI
   pyMMF.estimateNumModesGRIN

```
<!-- ## `IndexProfile` class

```eval_rst
Methods
-------
.. autosummary::
   :toctree: generated/
   
   pyMMF.IndexProfile.initFromArray
   pyMMF.IndexProfile.initParabolicGRIN
   pyMMF.IndexProfile.initStepIndex
   pyMMF.IndexProfile.initFromRadialFunction
   pyMMF.IndexProfile.fromFile
   pyMMF.IndexProfile.load
   pyMMF.IndexProfile.save
   pyMMF.IndexProfile.plot
   pyMMF.IndexProfile.getOptimalSolver




```

## `Modes` class

```eval_rst
Methods
-------

.. automethod:: pyMMF.Modes.fromFile
.. automethod:: pyMMF.Modes.load
.. automethod:: pyMMF.Modes.save
.. automethod:: pyMMF.Modes.sort
.. automethod:: pyMMF.Modes.getModeMatrix
.. automethod:: pyMMF.Modes.getEvolutionOperator
.. automethod:: pyMMF.Modes.getPropagationMatrix
.. automethod:: pyMMF.Modes.getCurvedModes
.. automethod:: pyMMF.Modes.getNearDegenerate
.. automethod:: pyMMF.Modes.getNearDegenerateMask
```

## `propagationModeSolver` class

```eval_rst
Methods
-------
.. autosummary::
   :toctree: generated/

   pyMMF.propagationModeSolver.setIndexProfile
   pyMMF.propagationModeSolver.setWL
   pyMMF.propagationModeSolver.setPoisson
   pyMMF.propagationModeSolver.solve
```
 -->