.. gaitmod documentation master file ...

gaitmod documentation
=======================

**gaitmod** is a Python library for processing, analyzing, and modeling multi-modal neural and movement data, including LFP, EEG, EMG, and IMU signals. It focuses on real-time gait modulation prediction in Parkinson's disease and supports customizable deep learning pipelines.


It provides tools to:

* Preprocess and clean multi-modal data
* Extract and select features from neural and movement signals
* Train and evaluate machine learning models
* Visualize results and model performance

This documentation provides installation instructions, usage examples, and a detailed API reference.

.. toctree::
   :maxdepth: 2
   :caption: Documentation

   installation
   usage
   api
   examples/index
   readme
   results
   contributing
   changelog