Skip to content

Commit

Permalink
Version & setup for new release
Browse files Browse the repository at this point in the history
  • Loading branch information
TomDonoghue committed Sep 4, 2019
1 parent 251f18b commit 45e0318
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 15 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Latest Version](https://img.shields.io/pypi/v/neurodsp.svg)](https://pypi.python.org/pypi/neurodsp/)
[![Build Status](https://travis-ci.org/neurodsp-tools/neurodsp.svg)](https://travis-ci.org/neurodsp-tools/neurodsp)
[![codecov](https://codecov.io/gh/neurodsp-tools/neurodsp/branch/master/graph/badge.svg)](https://codecov.io/gh/neurodsp-tools/neurodsp)
[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE.md)
[![License](https://img.shields.io/pypi/l/neurodsp.svg)](https://opensource.org/licenses/Apache-2.0)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/neurodsp.svg)](https://pypi.python.org/pypi/neurodsp/)
[![DOI](http://joss.theoj.org/papers/10.21105/joss.01272/status.svg)](https://doi.org/10.21105/joss.01272)

Expand All @@ -14,8 +14,9 @@ A package of tools to analyze and simulate neural time series, using digital sig

Documentation for the NeuroDSP module is available [here](https://neurodsp-tools.github.io/neurodsp/).

The documentation also includes a full set of [tutorials](https://neurodsp-tools.github.io/neurodsp/auto_tutorials/index.html)
covering the functionality of NeuroDSP.
The documentation also includes a set of [tutorials](https://neurodsp-tools.github.io/neurodsp/auto_tutorials/index.html)
describing each module in NeuroDSP, as well as a set of [examples](https://neurodsp-tools.github.io/neurodsp/auto_examples/index.html)
of applications of NeuroDSP.

If you have a question about using NeuroDSP that doesn't seem to be covered by the documentation, feel free to
open an [issue](https://github.com/neurodsp-tools/neurodsp/issues) and ask!
Expand All @@ -36,23 +37,23 @@ We recommend using the [Anaconda](https://www.continuum.io/downloads) distributi

**Stable Release Version**

To install the latest release of neurodsp, you can install from pip:
To install the latest stable release, use pip:

`$ pip install neurodsp`

**Development Version**

To get the development version (updates that are not yet published to pip), you can clone this repo.
To get the current development version, first clone this repository:

`$ git clone https://github.com/neurodsp-tools/neurodsp`

To install this cloned copy of neurodsp, move into the directory you just cloned, and run:
To install this cloned copy, move into the directory you just cloned, and run:

`$ pip install .`

**Editable Version**

If you want to install an editable version, for making contributions, download the development version as above, and run:
To install an editable version, download the development version as above, and run:

`$ pip install -e .`

Expand Down
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
'navbar_links': [
("API", "api"),
("Glossary", "glossary"),
("Tutorial", "auto_tutorials/index"),
("Tutorials", "auto_tutorials/index"),
("Examples", "auto_examples/index"),
("GitHub", "https://github.com/neurodsp-tools/neurodsp", True)
],
Expand Down
2 changes: 1 addition & 1 deletion neurodsp/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '2.0.0rc1'
__version__ = '2.0.0'
21 changes: 15 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
Neurodsp
========
A package of tools to analyze and simulate neural time series, using digital signal processing.
NeuroDSP is package of tools to analyze and simulate neural time series, using digital signal processing.
Available modules in NeuroDSP include:
Expand All @@ -27,27 +27,36 @@
- timefrequency : Estimate instantaneous measures of oscillatory activity
- sim : Simulate time series, including periodic and aperiodic signal components
- plts : Plotting functions
If you use this code in your project, please cite:
Cole, S., Donoghue, T., Gao, R., & Voytek, B. (2019). NeuroDSP: A package for
neural digital signal processing. Journal of Open Source Software, 4(36), 1272.
https://doi.org/10.21105/joss.01272
Direct Link: https://doi.org/10.21105/joss.01272
"""

setup(
name = 'neurodsp',
version = __version__,
description = 'Digital Signal Processing for Neural time series',
description = 'Digital signal processing for neural time series.',
long_description = long_description,
author = 'The Voytek Lab',
author_email = '[email protected]',
url = 'https://github.com/neurodsp-tools/neurodsp',
packages = find_packages(),
license = 'MIT',
license = 'Apache License, 2.0',
download_url = 'https://github.com/neurodsp-tools/neurodsp/releases',
keywords = ['neuroscience', 'neural oscillations', 'time series analysis', 'spectral analysis', 'LFP'],
keywords = ['neuroscience', 'neural oscillations', 'time series analysis', 'local field potentials',
'spectral analysis', 'time frequency analysis', 'electrophysiology'],
install_requires = ['numpy', 'scipy', 'matplotlib'],
tests_require = ['pytest'],
classifiers = [
'Development Status :: 4 - Beta',
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Science/Research',
'Topic :: Scientific/Engineering',
'License :: OSI Approved :: MIT License',
'License :: OSI Approved :: Apache Software License',
'Operating System :: MacOS :: MacOS X',
'Operating System :: Microsoft :: Windows',
'Operating System :: POSIX :: Linux',
Expand Down

0 comments on commit 45e0318

Please sign in to comment.