Skip to content

Commit

Permalink
Update readme and index
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelgarcia committed Feb 2, 2022
1 parent e156531 commit dbe3fe3
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 30 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,30 +47,24 @@ SpikeInterface is a Python framework designed to unify preexisting spike sorting



`spikeinterface` version 0.90:

* breaks backward compatibility with 0.10/0.11/0.12/0.13 series.
* has been first released in July 2021 (0.90.0)
* is not a meta-package anymore
* it doesn't depend on spikeextractors/spiketoolkit/spikesorters/spikecomparison/spikewidgets anymore


**Please have a look at the [eLife paper](https://elifesciences.org/articles/61834) that describes in detail this project**

You can also have a look at the [spikeinterface-gui](https://https://github.com/SpikeInterface/spikeinterface-gui).

## Documentation

All documentation for spikeinterface 0.90 can be found [here](https://spikeinterface.readthedocs.io/en/latest/).
All documentation for spikeinterface 0.93 can be found [here](https://spikeinterface.readthedocs.io/en/latest/).

Documentation of current API release 0.12.0 is [here](https://spikeinterface.readthedocs.io/en/stable/).

## How to install new SI version (0.90)


## How to install spikeinteface version

You can install the new `spikeinterface` version with pip:

```bash
pip install spikeinterface==0.90
pip install spikeinterface
```

To get the latest updates, you can install `spikeinterface` from sources:
Expand All @@ -82,12 +76,23 @@ python setup.py install (or develop)
cd ..
```

## version note

`spikeinterface` version 0.90 > 0.93:

* breaks backward compatibility with 0.10/0.11/0.12/0.13 series.
* has been first released in July 2021 (0.90.0)
* is not a meta-package anymore
* it doesn't depend on spikeextractors/spiketoolkit/spikesorters/spikecomparison/spikewidgets anymore


To install the olde `spikeinterface` API, you can use pip and point to the old version:

```bash
pip install spikeinterface==0.13
```

The recommended is to use new version.

## Citation

Expand Down
35 changes: 16 additions & 19 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,6 @@ Welcome to SpikeInterface's documentation!
==========================================



.. warning::

This is the documentation for SpikeInterface (0.90.0), which breaks compatibility with version 0.13.0.

See the documentation for the version 0.13.0 (old API) `here <https://spikeinterface.readthedocs.io/en/0.13.0/>`_.

.. image:: images/logo.png
:scale: 100 %
:align: center
Expand All @@ -29,19 +22,9 @@ With SpikeInterface, users can:
- compute quality metrics to validate and curate spike sorting outputs
- visualize recordings and spike sorting outputs.
- export report and export to phy with one line
- offer a powerfull Qt based viewer in separate package `spikeinterface-gui <https://https://github.com/SpikeInterface/spikeinterface-gui>`_
- have some powerfull sorting components to build your own sorter.

**NEWS**

- New SpikeInterface major release! Version 0.90.0 is out!

* breaks backward compatibility with 0.10/0.11/0.12/0.13 series
* has been released on 31st July 2021
* is not a metapackage anymore
* doesn't depend on spikeextractors/spiketoolkit/spikesorters/spikecomparison/spikewidgets sub-packages

Please see the release notes here: :ref:`release0.90.0`

- spikeinterface now has its own GUI. See `spikeinterface-gui <https://https://github.com/SpikeInterface/spikeinterface-gui>`_

.. toctree::
:maxdepth: 2
Expand Down Expand Up @@ -69,6 +52,20 @@ For more information, please have a look at:

- A collection of analysis notebook `SpikeInterface Reports <https://spikeinterface.github.io/>`_


**version notes**

- SpikeInterface get a major release in July 2021 (version 0.90.0)

* breaks backward compatibility with 0.10/0.11/0.12/0.13 series
* is not a metapackage anymore
* doesn't depend on spikeextractors/spiketoolkit/spikesorters/spikecomparison/spikewidgets sub-packages

Please see the release notes here: :ref:`release0.90.0`

See the documentation for the version 0.13.0 (old API) `here <https://spikeinterface.readthedocs.io/en/0.13.0/>`_.


.. Indices and tables
.. ==================
..
Expand Down

0 comments on commit dbe3fe3

Please sign in to comment.