Skip to main content

A Python toolkit for building neuroimaging data pipelines.

Project description

neuralset

A Python toolkit for building neuroimaging data pipelines — from raw data to AI-ready batched tensors.

  • Event-driven processing with typed, validated DataFrames
  • Multi-modal extractors for MEG, EEG, fMRI, EMG, iEEG, text, image, audio, video
  • Caching and remote compute via exca

Install

pip install neuralset

Quick example

# First install study dependencies:
# pip install neuralfetch
import neuralset as ns

# Load a study and download its data (MNE sample, ~1.6GB on first run).
study = ns.Study(name="Mne2013Sample", path=ns.CACHE_FOLDER)
study.download()
events = study.run()

# Configure extractors
meg = ns.extractors.MegExtractor(frequency=100.0, filter=(0.5, 30))

# Segment around triggers and build a dataset
segmenter = ns.Segmenter(
    extractors=dict(meg=meg),
    trigger_query='type == "Stimulus"',
    start=-0.1, duration=0.5,
)
dataset = segmenter.apply(events)
batch = dataset.load_all()

Citation

If you use NeuralSet in your research, please cite NeuralSet: A High-Performing Python Package for Neuro-AI:

@article{king2026neuralset,
  title   = {NeuralSet: A High-Performing Python Package for Neuro-AI},
  author  = {King, J-R. and Bel, C. and Evanson, L. and Gadonneix, J. and Houhamdi, S. and L{\'e}vy, J. and Raugel, J. and Santos Revilla, A. and Zhang, M. and Bonnaire, J. and Caucheteux, C. and D{\'e}fossez, A. and Desbordes, T. and Diego-Sim{\'o}n, P. and Khanna, S. and Millet, J. and Orhan, P. and Panchavati, S. and Ratouchniak, A. and Thual, A. and Brooks, T. and Begany, K. and Benchetrit, Y. and Careil, M. and Banville, H. and d'Ascoli, S. and Dahan, S. and Rapin, J.},
  year    = {2026},
  url     = {https://kingjr.github.io/files/neuralset.pdf},
  note    = {Preprint; URL will be updated when the paper lands on arXiv}
}

Third-Party Content

References to third-party content from other locations are subject to their own licenses and you may have other legal obligations or restrictions that govern your use of that content.

License

This project is licensed under the MIT License. See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neuralset-0.2.0.tar.gz (206.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

neuralset-0.2.0-py3-none-any.whl (239.3 kB view details)

Uploaded Python 3

File details

Details for the file neuralset-0.2.0.tar.gz.

File metadata

  • Download URL: neuralset-0.2.0.tar.gz
  • Upload date:
  • Size: 206.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for neuralset-0.2.0.tar.gz
Algorithm Hash digest
SHA256 428cee933697a3573194b45d7a166ab65db4cb901b7d9c9bf25cad5287c48478
MD5 210809762201d872622f551d221c1341
BLAKE2b-256 b39b0864917841f6676cd120d7d47c28ff31d91cf60f67e4e1efb0e712f609f8

See more details on using hashes here.

File details

Details for the file neuralset-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: neuralset-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 239.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for neuralset-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 db96f32dde2ff6553ca485a498b28558a2cef32917ad647283e51662c71ef3f9
MD5 73f7ed2858c98a98af524d61154c29ff
BLAKE2b-256 0c33cf2fd8a78eb51613d15060b62cd2c982bdc06c14052772a84ffd0ddeb528

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page