.. mmer documentation master file.

MMER's Documentation!
==================================

MMER is a Python package for Multivariate Mixed-Effects Regression.

* Supports flexible fixed effects (parametric or machine learning)
* Supports multiple responses
* Supports multiple grouping factors
* Supports linear random effects
* provides covariance matrices of random effects and residuals


This documentation provides installation, examples, and a practical public API reference.

.. toctree::
   :maxdepth: 1
   :caption: Installation

   source/installation

.. toctree::
   :maxdepth: 1
   :caption: Examples

   source/examples_index

.. toctree::
   :maxdepth: 1
   :caption: API Reference

   source/api