[MNT] - Update installation instructions

README.rst

@@ -1,12 +1,16 @@
 hsntools
 ========
 
-|ProjectStatus| |BuildStatus| |Coverage|
+|ProjectStatus| |Version| |BuildStatus| |Coverage| |License| |PythonVersions|
 
 .. |ProjectStatus| image:: http://www.repostatus.org/badges/latest/active.svg
    :target: https://www.repostatus.org/#active
    :alt: project status
 
+.. |Version| image:: https://img.shields.io/pypi/v/hsntools.svg
+   :target: https://pypi.org/project/hsntools/
+   :alt: version
+
 .. |BuildStatus| image:: https://github.com/HSNPipeline/hsntools/actions/workflows/build.yml/badge.svg
    :target: https://github.com/HSNPipeline/hsntools/actions/workflows/build.yml
    :alt: build statue
@@ -15,6 +19,14 @@ hsntools
    :target: https://codecov.io/gh/HSNPipeline/hsntools
    :alt: coverage
 
+.. |License| image:: https://img.shields.io/pypi/l/hsntools.svg
+   :target: https://opensource.org/license/mit
+   :alt: license
+
+.. |PythonVersions| image:: https://img.shields.io/pypi/pyversions/hsntools.svg
+   :target: https://pypi.org/project/hsntools/
+   :alt: python versions
+
 ``hsntools`` (formerly 'convnwb') is a module for working with the Human Single-Neuron Pipeline (HSNPipeline).
 
 Overview
@@ -93,24 +105,42 @@ There are also optional dependencies, that offer extra functionality:
 Installation
 ------------
 
-The current release version is the 0.4.X series.
+The current release version of `hsntools` is the 1.X.X release series.
 
-Check the
+See the
 `changelog <https://hsnpipeline.github.io/hsntools/changelog>`_
-for notes on updates and changes across versions.
+for notes on major version releases.
+
+**Stable Release Version**
+
+To install the latest stable release, you can use pip:
+
+.. code-block:: shell
+
+    $ pip install hsntools
 
-This module should be installed from Github:
+**Development Version**
 
-**Install from a clone**
+To get the current development version, first clone this repository:
 
-First clone this repository, then move into the cloned repository, and install:
+.. code-block:: shell
+
+    $ git clone https://github.com/hsnpipeline/hsntools
+
+To install this cloned copy, move into the directory you just cloned, and run:
 
 .. code-block:: shell
 
-    $ git clone https://github.com/HSNPipeline/hsntools
-    $ cd hsntools
     $ pip install .
 
+**Editable Version**
+
+To install an editable version, download the development version as above, and run:
+
+.. code-block:: shell
+
+    $ pip install -e .
+
 Contribute
 ----------
 

optional-requirements.txt

@@ -1,8 +1,8 @@
-pynwb
 matplotlib
+scipy
 scikit-learn
 pandas
-scipy
 h5py
+pynwb
+neo
 mat73
-neo

setup.py

@@ -18,14 +18,14 @@
 setup(
     name = 'hsntools',
     version = __version__,
-    description = 'Code for working with the Human Single-Neuron Pipeline',
+    description = 'Code for working with the Human Single-Neuron Pipeline.',
     long_description = long_description,
     long_description_content_type = 'text/x-rst',
     python_requires = '>=3.7',
     packages = find_packages(),
     license = 'MIT License',
     classifiers = [
-        'Development Status :: 4 - Beta',
+        'Development Status :: 5 - Production/Stable',
         'Intended Audience :: Science/Research',
         'Topic :: Scientific/Engineering',
         'License :: OSI Approved :: MIT License',
@@ -54,9 +54,11 @@
     install_requires = install_requires,
     tests_require = ['pytest'],
     extras_require = {
-        'compute' : ['scipy', 'scikit-learn'],
-        'data' : ['pandas', 'h5py', 'pynwb'],
         'plot' : ['matplotlib'],
-        'all' : ['scipy', 'scikit-learn', 'pandas', 'h5py', 'pynwb', 'matplotlib'],
+        'timestamps' : ['scipy', 'scikit-learn'],
+        'nwb' : ['h5py', 'pynwb'],
+        'files' : ['scipy', 'pandas', 'h5py', 'pynwb', 'neo', 'mat73'],
+        'tests' : ['pytest'],
+        'all' : ['matplotlib', 'scipy', 'scikit-learn', 'pandas', 'h5py', 'pynwb', 'neo', 'mat73', 'pytest'],
     }
 )