.. stochkin documentation master file

stochkin – stochastic kinetics toolkit
=======================================

**stochkin** is a Python library for stochastic kinetics on 1-D and 2-D
free-energy surfaces.  It provides Fokker–Planck / CTMC analysis,
Langevin dynamics, mean first-passage time estimation, minimum
free-energy path search, and publication-quality plotting — all from a
single ``pip install``.

.. note::
   stochkin v\ |release| requires Python ≥ 3.9 and NumPy.
   SciPy and FiPy are optional but unlock advanced solvers.

Quick links
-----------

* :doc:`getting_started` — installation, first example, key concepts.
* :doc:`api/index` — full API reference (auto-generated from docstrings).

The repository also ships runnable example scripts in ``examples/`` and
matching Jupyter notebooks in ``notebooks/`` for the main workflows.

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

   getting_started
   api/index


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`