Skip to content

Commit

Permalink
Install doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelgarcia committed May 17, 2021
1 parent 6e77793 commit 1c3fdb2
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 4 deletions.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,32 @@ SpikeInterface is a Python framework designed to unify preexisting spike sorting

## Documentation

All documentation for SpikeInterface can be found [here](https://spikeinterface.readthedocs.io/en/latest/).
All documentation for spikeinterface work-in-progress 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 work-in-progress version

Here a simple recipe to install work-in-progress version (0.90.0.dev0):

```
git clone https://github.com/NeuralEnsemble/python-neo.git
cd python-neo
python setup.py install (or develop)
cd ..
git clone https://github.com/SpikeInterface/probeinterface.git
cd probeinterface
python setup.py install (or develop)
cd ..
git clone https://github.com/SpikeInterface/spikeinterface.git
cd spikeinterface
python setup.py install (or develop)
cd ..
```


## Citation

If you find SpikeInterface useful in your research, please cite:
Expand Down
20 changes: 17 additions & 3 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,30 @@ Installation
:code:`spikeinterface` is a Python package.

The actual "new API" (v0.90.0) is not release on pypi yet.
It will release
in July 2021
It will be released in July 2021. Maybe.


To use it now, you have to install `spikeinterface` work-in-progress
from source but also neo and probeinterface:

To use it now, you have to install `spikeinterface` from source:

.. code-block:: bash
git clone https://github.com/NeuralEnsemble/python-neo.git
cd python-neo
python setup.py install (or develop)
cd ..
git clone https://github.com/SpikeInterface/probeinterface.git
cd probeinterface
python setup.py install (or develop)
cd ..
git clone https://github.com/SpikeInterface/spikeinterface.git
cd spikeinterface
python setup.py install (or develop)
cd ..
Expand Down

0 comments on commit 1c3fdb2

Please sign in to comment.