wonambi


Namewonambi JSON
Version 7.12 PyPI version JSON
download
home_pagehttps://github.com/wonambi-python/wonambi
SummaryTools for EEG, ECoG, iEEG, especially for sleep
upload_time2023-07-10 20:06:59
maintainer
docs_urlNone
authorGio Piantoni / Jordan O'Byrne
requires_python
licenseGPLv3
keywords neuroscience analysis sleep eeg ecog
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            WONAMBI
=======
Package for the analysis of EEG, ECoG and other electrophysiology modalities.
Allows for visualization of the data and sleep stage scoring in a GUI.
Provides automatic detectors for spindles and slow waves.

Features
--------
- Can read files of format:

  - Axon (.abf, ABF2 only)
  - BCI2000 (.dat)
  - Blackrock (.nev, .ns2, .ns3, .ns5)
  - Brain Vision (.vhdr, .vmrk, .eeg / .dat)
  - EEGLAB (.set, .set / .fdt)
  - European Data Format (.edf)
  - EGI MFF (.mff)
  - Fieldtrip (.mat)
  - mne FIFF (.fiff)
  - SystemPlus Micromed (.trc)
  - Moberg ("EEG,Composite,SampleSeries,Composite,MRIAmp,data")
  - openephys (.continuous, .openephys)
  - BIDS-formatted data file

- Interface for Sleep Scoring

- Computes frequency analysis (spectrogram), time-frequency analysis (short-time spectrogram, Morlet wavelet)

- Detection of spindles and slow waves

- Pure Python

Installation
------------
Install wonambi by running:

    pip3 install wonambi

See `Installation for details <http://wonambi-python.github.io/installation.html>`_

If you want to scroll recordings and do some sleep scoring (requires PyQt5)

    wonambi

Run it!
-------
From the command line, simply type:

    wonambi

To open a dataset directly, add the full path to the file you want to open:

    wonambi /home/me/sleep_recordings.edf

Documentation
-------------
See `Documentation <http://wonambi-python.github.io/>`_

Change Log
----------
See `Change Log <http://wonambi-python.github.io/changelog.html>`_

Requirements
------------
- Python 3.6 or later
- numpy
- scipy

Optional Requirements
---------------------
- PyQt5 (optional for sleep scoring GUI)
- python-vlc (optional, to watch embedded movies)
- vispy (optional to plot 3D brain surfaces and electrodes)
- h5py (optional to read FieldTrip Matlab files)
- mne (optional, to export to mne FIFF files)
- nibabel (optional to read freesurfer)
- tensorpac (optional to run phase-amplitude analysis, tensorpac version should be 0.5.6)
- fooof 1.0 (optional to run parametrization of power spectra)

Status
------
.. image:: https://travis-ci.com/wonambi-python/wonambi.svg?branch=master
    :target: https://travis-ci.com/wonambi-python/wonambi

.. image:: https://codecov.io/gh/wonambi-python/wonambi/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/wonambi-python/wonambi

License
-------
The project is licensed under the 3-clause BSD license.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/wonambi-python/wonambi",
    "name": "wonambi",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "neuroscience analysis sleep EEG ECoG",
    "author": "Gio Piantoni / Jordan O'Byrne",
    "author_email": "wonambi@gpiantoni.com",
    "download_url": "https://files.pythonhosted.org/packages/3e/b9/1f31a975c4174567a138422c6fbb9412cb1c426fddccf9601e2fca4757da/wonambi-7.12.tar.gz",
    "platform": null,
    "description": "WONAMBI\n=======\nPackage for the analysis of EEG, ECoG and other electrophysiology modalities.\nAllows for visualization of the data and sleep stage scoring in a GUI.\nProvides automatic detectors for spindles and slow waves.\n\nFeatures\n--------\n- Can read files of format:\n\n  - Axon (.abf, ABF2 only)\n  - BCI2000 (.dat)\n  - Blackrock (.nev, .ns2, .ns3, .ns5)\n  - Brain Vision (.vhdr, .vmrk, .eeg / .dat)\n  - EEGLAB (.set, .set / .fdt)\n  - European Data Format (.edf)\n  - EGI MFF (.mff)\n  - Fieldtrip (.mat)\n  - mne FIFF (.fiff)\n  - SystemPlus Micromed (.trc)\n  - Moberg (\"EEG,Composite,SampleSeries,Composite,MRIAmp,data\")\n  - openephys (.continuous, .openephys)\n  - BIDS-formatted data file\n\n- Interface for Sleep Scoring\n\n- Computes frequency analysis (spectrogram), time-frequency analysis (short-time spectrogram, Morlet wavelet)\n\n- Detection of spindles and slow waves\n\n- Pure Python\n\nInstallation\n------------\nInstall wonambi by running:\n\n    pip3 install wonambi\n\nSee `Installation for details <http://wonambi-python.github.io/installation.html>`_\n\nIf you want to scroll recordings and do some sleep scoring (requires PyQt5)\n\n    wonambi\n\nRun it!\n-------\nFrom the command line, simply type:\n\n    wonambi\n\nTo open a dataset directly, add the full path to the file you want to open:\n\n    wonambi /home/me/sleep_recordings.edf\n\nDocumentation\n-------------\nSee `Documentation <http://wonambi-python.github.io/>`_\n\nChange Log\n----------\nSee `Change Log <http://wonambi-python.github.io/changelog.html>`_\n\nRequirements\n------------\n- Python 3.6 or later\n- numpy\n- scipy\n\nOptional Requirements\n---------------------\n- PyQt5 (optional for sleep scoring GUI)\n- python-vlc (optional, to watch embedded movies)\n- vispy (optional to plot 3D brain surfaces and electrodes)\n- h5py (optional to read FieldTrip Matlab files)\n- mne (optional, to export to mne FIFF files)\n- nibabel (optional to read freesurfer)\n- tensorpac (optional to run phase-amplitude analysis, tensorpac version should be 0.5.6)\n- fooof 1.0 (optional to run parametrization of power spectra)\n\nStatus\n------\n.. image:: https://travis-ci.com/wonambi-python/wonambi.svg?branch=master\n    :target: https://travis-ci.com/wonambi-python/wonambi\n\n.. image:: https://codecov.io/gh/wonambi-python/wonambi/branch/master/graph/badge.svg\n    :target: https://codecov.io/gh/wonambi-python/wonambi\n\nLicense\n-------\nThe project is licensed under the 3-clause BSD license.\n",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "Tools for EEG, ECoG, iEEG, especially for sleep",
    "version": "7.12",
    "project_urls": {
        "Homepage": "https://github.com/wonambi-python/wonambi"
    },
    "split_keywords": [
        "neuroscience",
        "analysis",
        "sleep",
        "eeg",
        "ecog"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ab4b1a5fa84a51202207eed893d2f04034c4023cfd640f67031a09e6ad059755",
                "md5": "17ca7604d9ff8cf32ba5eba2a1db3373",
                "sha256": "45fcc0ddf82ffe982064a044d8e30e48127a10d4ea0ca726e4edb3a7e2ff5af9"
            },
            "downloads": -1,
            "filename": "wonambi-7.12-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "17ca7604d9ff8cf32ba5eba2a1db3373",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 344903,
            "upload_time": "2023-07-10T20:06:57",
            "upload_time_iso_8601": "2023-07-10T20:06:57.736788Z",
            "url": "https://files.pythonhosted.org/packages/ab/4b/1a5fa84a51202207eed893d2f04034c4023cfd640f67031a09e6ad059755/wonambi-7.12-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3eb91f31a975c4174567a138422c6fbb9412cb1c426fddccf9601e2fca4757da",
                "md5": "0d571e01f22ae50a3e9e3892630a092b",
                "sha256": "e082018e199ba9ce52168b7e1caf6709f443cf69d9cf859774259236d221fcc2"
            },
            "downloads": -1,
            "filename": "wonambi-7.12.tar.gz",
            "has_sig": false,
            "md5_digest": "0d571e01f22ae50a3e9e3892630a092b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 324256,
            "upload_time": "2023-07-10T20:06:59",
            "upload_time_iso_8601": "2023-07-10T20:06:59.811462Z",
            "url": "https://files.pythonhosted.org/packages/3e/b9/1f31a975c4174567a138422c6fbb9412cb1c426fddccf9601e2fca4757da/wonambi-7.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-10 20:06:59",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "wonambi-python",
    "github_project": "wonambi",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "appveyor": true,
    "lcname": "wonambi"
}
        
Elapsed time: 0.08876s