Skip to content

Commit

Permalink
add "try it on ebrains" button for elephant tutorials (NeuralEnsemble…
Browse files Browse the repository at this point in the history
…#538)

* add "try it on ebrains" button for elephant tutorials

* replace try it on ebrains button image with a badge

* change indentation of badge

* modify description

* change text of shield to "launch ebrains" to be in line with the binder badge

* update documentation on tutorials, add section describing the difference between ebrains and binder

---------

Co-authored-by: Michael Denker <m.denker@fz-juelich.de>
  • Loading branch information
Moritz-Alexander-Kern and mdenker committed Feb 23, 2023
1 parent 13d7bb8 commit 99d3555
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions doc/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,15 @@ Tutorials

These tutorials provide narrative explanations, sample code, and expected
output for some of the neurophysiological analyses in Elephant. You can browse
the tutorials or launch them in mybinder to change and interact with the code.
the tutorials, launch them in mybinder or try them on ebrains to change and
interact with the code.

Launching a notebook on EBRAINS and Binder both provide a convenient way to
run and interact with code. The main difference between the two is that
changes made to a notebook launched on Binder are not saved, while
changes made to a notebook launched on EBRAINS are persistent and bound to the
user's EBRAINS account. This makes EBRAINS a great choice if you want to save
your work and come back to it later.

Introductory
------------
Expand All @@ -20,7 +27,8 @@ Introductory

.. image:: https://mybinder.org/badge.svg
:target: https://mybinder.org/v2/gh/NeuralEnsemble/elephant/master?filepath=doc/tutorials/statistics.ipynb

.. image:: https://img.shields.io/badge/launch-ebrains-brightgreen
:target: https://lab.ch.ebrains.eu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2FNeuralEnsemble%2Felephant&urlpath=lab%2Ftree%2Felephant%2Fdoc%2Ftutorials%2Fstatistics.ipynb&branch=master

Advanced
--------
Expand All @@ -36,6 +44,9 @@ Advanced

.. image:: https://mybinder.org/badge.svg
:target: https://mybinder.org/v2/gh/NeuralEnsemble/elephant/master?filepath=doc/tutorials/unitary_event_analysis.ipynb
..
.. image:: https://img.shields.io/badge/launch-ebrains-brightgreen
:target: https://lab.ch.ebrains.eu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2FNeuralEnsemble%2Felephant&urlpath=lab%2Ftree%2Felephant%2Fdoc%2Ftutorials%2F+unitary_event_analysis.ipynb&branch=master
* Gaussian Process Factor Analysis (GPFA).

Expand All @@ -46,27 +57,35 @@ Advanced

.. image:: https://mybinder.org/badge.svg
:target: https://mybinder.org/v2/gh/NeuralEnsemble/elephant/master?filepath=doc/tutorials/gpfa.ipynb
.. image:: https://img.shields.io/badge/launch-ebrains-brightgreen
:target: https://lab.ch.ebrains.eu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2FNeuralEnsemble%2Felephant&urlpath=lab%2Ftree%2Felephant%2Fdoc%2Ftutorials%2Fgpfa.ipynb&branch=master

* Spike Pattern Detection and Evaluation (SPADE)

:doc:`View the notebook <../tutorials/spade>` or run interactively:

.. image:: https://mybinder.org/badge.svg
:target: https://mybinder.org/v2/gh/NeuralEnsemble/elephant/master?filepath=doc/tutorials/spade.ipynb
.. image:: https://img.shields.io/badge/launch-ebrains-brightgreen
:target: https://lab.ch.ebrains.eu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2FNeuralEnsemble%2Felephant&urlpath=lab%2Ftree%2Felephant%2Fdoc%2Ftutorials%2Fspade.ipynb&branch=master

* Analysis of Sequences of Synchronous EvenTs (ASSET)

:doc:`View the notebook <../tutorials/asset>` or run interactively:

.. image:: https://mybinder.org/badge.svg
:target: https://mybinder.org/v2/gh/NeuralEnsemble/elephant/master?filepath=doc/tutorials/asset.ipynb
.. image:: https://img.shields.io/badge/launch-ebrains-brightgreen
:target: https://lab.ch.ebrains.eu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2FNeuralEnsemble%2Felephant&urlpath=lab%2Ftree%2Felephant%2Fdoc%2Ftutorials%2Fasset.ipynb&branch=master

* Granger causality

:doc:`View the notebook <../tutorials/granger_causality>` or run interactively:

.. image:: https://mybinder.org/badge.svg
:target: https://mybinder.org/v2/gh/NeuralEnsemble/elephant/master?filepath=doc/tutorials/granger_causality.ipynb
.. image:: https://img.shields.io/badge/launch-ebrains-brightgreen
:target: https://lab.ch.ebrains.eu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2FNeuralEnsemble%2Felephant&urlpath=lab%2Ftree%2Felephant%2Fdoc%2Ftutorials%2Fgranger_causality.ipynb+&branch=master


Additional
Expand All @@ -81,6 +100,8 @@ Additional

.. image:: https://mybinder.org/badge.svg
:target: https://mybinder.org/v2/gh/NeuralEnsemble/elephant/master?filepath=doc/tutorials/parallel.ipynb
.. image:: https://img.shields.io/badge/launch-ebrains-brightgreen
:target: https://lab.ch.ebrains.eu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2FNeuralEnsemble%2Felephant&urlpath=lab%2Ftree%2Felephant%2Fdoc%2Ftutorials%2Fparallel.ipynb+&branch=master

..
Index the notebooks in a hidden toctree to avoid sphinx warnings.
Expand Down

0 comments on commit 99d3555

Please sign in to comment.