Skip to main content

Neuroelectrophysiology tools

Project description

Travis-CI build status Test coverage Documentation Status

nept: Neuroelectrophysiology tools

Formerly vdmlab, renamed to emphasize general abilities of this module.

Getting started for beginners

Download Miniconda from Continuum Analytics. We support Python 3.

Open a new terminal, create and activate a new conda environment:

conda create -n yourenv python=3.5
activate yourenv [Windows] or source activate yourenv [Linux]

Install package dependencies:

conda install matplotlib jupyter scipy numpy pandas pytest coverage

For Shapely, try:

pip install shapely

In Windows, download the most recent wheel file here. Once downloaded, install with wheel.

pip install yourshapelyinstall.whl

Clone the analysis code from Github and use a developer installation:

git clone https://github.com/vandermeerlab/nept.git
cd nept
python setup.py develop

All set!

Documentation

Users

Check Read The Docs for the latest version of the nept documentation.

Developers

Ensure you have sphinx, numpydic, and mock:

conda install sphinx numpydoc mock

Build latest version of the documentation using in the nept directory prior to pushing it to Github:

python setup.py build_sphinx

Testing

Run tests with pytest.

Check coverage with codecov. Or in the command line:

py.test
coverage report

License

The nept codebase is made available under made available under the MIT license that allows using, copying, and sharing.

The file nept/neuralynx_loaders.py contains code from nlxio by Bernard Willers, used with permission.

Projects using nept

emi_shortcut

emi_biconditional

Project details


Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page