Skip to main content

NeuroneLoader

Build Status Coverage Status Documentation Status License PyPi Package Supported Python Versions JOSS status

NeuroneLoader is a python module for loading neurophysiological data recorded with Bittium NeurOne (formerly MegaEMG). It therefore allows using the data in pure python processing workflows using the python scientifc software stack (e.g. numpy) without the need of prior conversion using other (proprietary) software (e.g. MATLAB). It can also export it to container objects used by the popular python-mne framework.

Props to Andreas Henelius at Finnish Institute of Occupational Health for figuring out how to read the NeurOne binary format in pure python as part of his export2hdf project.

Installation

pip install neurone_loader

If you want to export to python-mne you must also install MNE and all it’s dependencies.

pip install mne

Quick start

>>> from neurone_loader import Recording
>>> rec = Recording(path_to_recording_folder)
>>> rec.event_codes
array([  0,   1,  12,  13,  99, 128], dtype=int32)

Please note that because raw EEG recordings can be quite large this package is very memory aware. Most data will be loaded from disk lazily, i.e. the moment you’re actually accessing it, and redundant data will be removed from memory as soon as it has been copied - unless you specify otherwise. Be advised that working with big recordings might still require a lot of memory.

I recommend looking at the docstrings before executing anything and maybe having a look at Concepts section in the Documentation before you start working with this package.

Contributing

If you encounter any problem feel free to open a issue on GitHub. If you found a bug and want to supply a fix or if you want to contribute a new feature open a pull request. Just make sure that your code is not breaking any tests and you also supply tests for your code.

Testing

To run the tests you must first get the test data and then you can run the test with the following commands. Please run them in the repository directory, not in the test subdirectory.

To get the test data (~2.8GB) you need to install wget. Then you can download the data by running

bash test/get_test_data.sh

Then you can run the tests with

python -m unittest discover -s test -t .

Metadata

Release files for neurone-loader 2.0.1

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

Built distribution (wheel)

Table of built distributions (wheels) for neurone-loader 2.0.1
File Interpreter ABI Platform Actions
neurone_loader-2.0.1-py2.py3-none-any.whl Python 3, Python 2 none any Details for neurone_loader-2.0.1-py2.py3-none-any.whl

Release files / neurone_loader-2.0.1-py2.py3-none-any.whl

Download URL neurone_loader-2.0.1-py2.py3-none-any.whl
Size 19.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
241289bcaba2f6faae8a7aa0d728bacedc1efc47acf875959af954d1fc576f97
BLAKE2b-256 checksum
How to use checksums
a1c458c28603c37794fbd129593eb05ae3d4e616206cd1759d35cc769a86f4d3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

Security for neurone-loader 2.0.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.

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