Skip to main content

MUniverse: Benchmarking Motor Unit Decomposition Algorithms

License: GPL v3 Python 3.11+

MUniverse is a modular framework for simulated and experimental EMG dataset generation, motor unit decomposition algorithm benchmarking, and performance evaluation. It integrates biomechanical simulation (via NeuroMotion), generative models (BioMime), standardized formats (e.g. BIDS/Croissant), and FAIR data hosting (Harvard Dataverse).

MUniverse overview

Features

  • 🔬 Algorithm Benchmarking: Compare multiple motor unit decomposition algorithms (CBSS, SCD, Upperbound, AE)
  • 📊 Dataset Generation: Generate simulated EMG datasets using NeuroMotion and experimental datasets
  • 📁 FAIR Data: Access datasets through Harvard Dataverse with BIDS and Croissant format support
  • 🔧 Containerized Workflows: Docker and Singularity support for reproducible algorithm execution
  • 📈 Performance Evaluation: Comprehensive evaluation metrics and report card generation
  • 📓 Tutorial Notebooks: Interactive Jupyter notebooks for dataset loading and algorithm usage

Installation

Requirements

  • Python 3.11 or higher
  • pip

Package Installation

MUniverse is distributed as a Python package. To set up the development environment:

  1. Clone the repository:
git clone https://github.com/dfarinagroup/muniverse.git
cd muniverse
  1. Create and activate a virtual environment:
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
  1. Install the package:
# Install core dependencies
pip install -e .

# Install development dependencies (optional)
pip install -e ".[dev]"

Docker/Singularity Containers

For algorithm execution, Docker or Singularity containers are available. See the docker/ directory for container definitions.

Quick Start

Loading a Dataset

from muniverse.datasets import load_dataset

# Load a dataset from Harvard Dataverse
dataset = load_dataset("neuromotion-test", output_dir="./data")

Running Decomposition

from muniverse.algorithms import decompose_recording

# Run decomposition using CBSS algorithm
results, metadata = decompose_recording(
    data="path/to/emg_data.edf",
    method="cbss"
)

# Or use SCD algorithm (requires container)
results, metadata = decompose_recording(
    data="path/to/emg_data.edf",
    method="scd",
    container="path/to/muniverse_scd.sif",
    engine="singularity"
)

Available Datasets

All datasets are hosted on Harvard Dataverse and follow FAIR principles:

Supported Algorithms

  • CBSS - Convolutional Blind Source Separation
  • SCD - Swarm Contrastive Decomposition (GitHub)
  • Upperbound - Upper bound performance estimation
  • AE - Autoencoder-based decomposition

Documentation (coming soon 🚧)

Project Structure

muniverse/
├── src/                    # Package source code
│   └── muniverse/
│       ├── configs/        # Algorithm and dataset configurations
│       ├── datasets/       # Dataset loading and simulation utilities
│       ├── algorithms/     # Decomposition algorithms
│       ├── evaluation/     # Performance evaluation
│       └── utils/          # Utility functions
├── notebooks/              # Tutorial notebooks
├── scripts/                # Utility scripts
├── docker/                 # Docker container definitions
├── docs/                   # GitHub Pages documentation (Coming soon!)
├── tests/                  # Unit tests
├── pyproject.toml          # Package configuration
└── README.md               

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Contributors

Acknowledgments

  • NeuroMotion - Biomechanical simulation framework (GitHub)
  • Swarm-Contrastive-Decomposition - Decomposition algorithm (GitHub)
  • Harvard Dataverse - FAIR data hosting platform
  • BIDS - Brain Imaging Data Structure standard

Citation

If you use MUniverse in your research, please cite:

@inproceedings{NEURIPS2025_dcce2899,
 author = {Mamidanna, Pranav and Klotz, Thomas and Chalatsis, Dimitrios and Grison, Agnese and Mendez Guerra, Irene and Ma, Shihan and Caillet, Arnault and Avrillon, Simon and Rohl\'{e}n, Robin and Farina, Dario},
 booktitle = {Advances in Neural Information Processing Systems},
 editor = {D. Belgrave and C. Zhang and H. Lin and R. Pascanu and P. Koniusz and M. Ghassemi and N. Chen},
 pages = {},
 publisher = {Curran Associates, Inc.},
 title = {MUniverse: A Simulation and Benchmarking Suite for Motor Unit Decomposition},
 url = {https://proceedings.neurips.cc/paper_files/paper/2025/file/dcce28990bf662c6b916c52cd7e975da-Paper-Datasets_and_Benchmarks_Track.pdf},
 volume = {38},
 year = {2025}
}

Contact

For questions, issues, or contributions, please:

  • Open an issue on GitHub
  • Contact the maintainers via email (see the Contributors section for author emails)

License

MUniverse is licensed under the GNU General Public License v3.0 (GPL-3.0).

Important Licensing Notes:

  • This project uses NeuroMotion, which is licensed under GNU GPL v3.0. As a result, MUniverse is also licensed under GNU GPL v3.0 to comply with the copyleft requirements of the GPL license.
  • This project also integrates with Swarm-Contrastive-Decomposition, which is licensed under Creative Commons Attribution-NonCommercial 4.0 International Public License.

See the LICENSE file for full details.

Metadata

Release files for muniverse-emg 0.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for muniverse-emg 0.1.5
File Size Uploaded Provenance Actions
muniverse_emg-0.1.5.tar.gz 3.2 MB Without provenance Details for muniverse_emg-0.1.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for muniverse-emg 0.1.5
File Interpreter ABI Platform Actions
muniverse_emg-0.1.5-py3-none-any.whl Python 3 none any Details for muniverse_emg-0.1.5-py3-none-any.whl

Total release size: 3.3 MB

Release files / muniverse_emg-0.1.5.tar.gz

Download URL muniverse_emg-0.1.5.tar.gz
Size 3.2 MB
Tags Source
SHA-256 checksum
How to use checksums
e2eccea520000f2e1f50e093d54ee686a2ac4355d1940fa66ee0395bb3733bcd
BLAKE2b-256 checksum
How to use checksums
bdf8823d039964bde4b918621ebc00bf683cdd7545cefa8e7af2b2fde78792b0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.13

Release files / muniverse_emg-0.1.5-py3-none-any.whl

Download URL muniverse_emg-0.1.5-py3-none-any.whl
Size 108.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e54513445382af3c78846059bab82cac5ea5111706512627b52ee67950131d54
BLAKE2b-256 checksum
How to use checksums
c5d2308b66e258d57747b982a22d80921544969335dfdf9d6a482a686e7f4a8c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.13

Security for muniverse-emg 0.1.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page