AutoCleanEEG Pipeline
A modular framework for automated EEG data processing, built on MNE‑Python.
Features
- Framework for automated EEG preprocessing with "lego block" modularity
- Support for multiple EEG paradigms (ASSR, Chirp, MMN, Resting State)
- BIDS-compatible data organization and comprehensive quality control
- Extensible plugin system for file formats, montages, and event processing
- Research-focused workflow: single file testing → parameter tuning → batch processing
- Detailed output: BIDS‑compatible derivatives, single task log file, stage files, exports, and QA visualizations
Installation (uv)
Use Astral's uv for fast, isolated installs. If you don't have uv yet, see https://docs.astral.sh/uv/
- Install CLI (recommended for users):
uv tool install autocleaneeg-pipeline
autocleaneeg-pipeline --help
- Upgrade or remove:
uv tool upgrade autocleaneeg-pipeline
uv tool uninstall autocleaneeg-pipeline
- Development install from source (editable install):
git clone https://github.com/cincibrainlab/autocleaneeg_pipeline.git
cd autocleaneeg_pipeline
uv tool install -e --upgrade . --force
autocleaneeg-pipeline --help # Slow on first run!
Documentation
Full documentation is available at https://docs.autocleaneeg.org
Development
For contributors, we provide a Makefile with convenient development commands:
make help # Show all available commands
make check # Run code quality checks
make format # Auto-format code
make lint # Run linting and type checking
make test # Run unit tests
make test-cov # Run tests with coverage
make ci-check # Run CI-equivalent checks locally
See CONTRIBUTING.md for full development guidelines.
Contributing
We welcome contributions! Please see our Contributing Guide for details. For branch workflow and cleanup expectations, see BRANCHING.md.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgments
- Cincinnati Children's Hospital Research Foundation
- Built with MNE-Python
1 maintainer
Metadata
1 maintainer
Release files for autocleaneeg-pipeline 3.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| autocleaneeg_pipeline-3.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Release files / autocleaneeg_pipeline-3.2.1-py3-none-any.whl
| Download URL | autocleaneeg_pipeline-3.2.1-py3-none-any.whl |
|---|---|
| Size | 1.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6cf60747a21aca467980f02e6ff8c5ab96c7896f9528ca0b4509828f925814f1
|
|
BLAKE2b-256 checksum How to use checksums |
d4af4e52ff554eb27769a2c9d08288fd4bfb32cbf2b063c29d01f10a599145e1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.0
|
Security for autocleaneeg-pipeline 3.2.1
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.
