Skip to content

Commit

Permalink
Documentation fixes (#455)
Browse files Browse the repository at this point in the history
* Update README.md

Added "Try on EBRAINS" button

* Updated README.md file

* Updated doc frontpag

* Updated version file

* Lint issue
  • Loading branch information
torbjone committed Nov 24, 2023
1 parent 47e9b51 commit ae7403e
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 5 deletions.
2 changes: 1 addition & 1 deletion LFPy/version.py
@@ -1 +1 @@
version = "2.3.1.dev0"
version = "2.3.1"
10 changes: 7 additions & 3 deletions README.md
Expand Up @@ -17,6 +17,13 @@ Usage
-----
A brief video tutorial on LFPy is available here: <https://youtu.be/gCQkyTHZ1lw>

LFPy is preinstalled at the EBRAINS collaboratory, and you can test LFPy online without installation, by clicking this button:

[![](https://nest-simulator.org/TryItOnEBRAINS.png)](https://lab.ebrains.eu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2FLFPy%2Ftutorial_at_EBRAINS&urlpath=tree%2Ftutorial_at_EBRAINS%2F&branch=main)

Note that you might need to be logged into an EBRAINS account for the link to work.
To get a free EBRAINS account, sign up here: https://www.ebrains.eu/page/sign-up

A basic simulation of extracellular potentials of a multicompartment neuron model set up with LFPy:

>>> # import modules
Expand Down Expand Up @@ -60,9 +67,6 @@ A basic simulation of extracellular potentials of a multicompartment neuron mode
>>> axes[2].set_ylabel('z (µm)')
>>> axes[2].set_xlabel('t (ms)')

You can now test some LFPy examples online without installation:
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LFPy/LFPy_binder_examples/master)

Code status
-----------

Expand Down
19 changes: 18 additions & 1 deletion doc/index.rst
Expand Up @@ -8,7 +8,24 @@
Welcome to LFPy's documentation!
================================

(Looking for the old LFPy v1.* documentation? Follow `link <https://lfpy.github.io/v1.3>`_)
A brief video tutorial on LFPy is available here:

.. raw:: html

<iframe width="560" height="315" src="https://www.youtube.com/embed/gCQkyTHZ1lw" frameborder="0" allowfullscreen></iframe>


======

You can test LFPy online without installation, by clicking this button:

.. figure:: https://nest-simulator.org/TryItOnEBRAINS.png
:target: https://lab.ebrains.eu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2FLFPy%2Ftutorial_at_EBRAINS&urlpath=tree%2Ftutorial_at_EBRAINS%2F&branch=main

Note that you might need to be logged into an EBRAINS account for the link to work.
To get a free EBRAINS account, sign up here: https://www.ebrains.eu/page/sign-up

Go to LFPy's source code: https://github.com/LFPy/LFPy

Contents
========
Expand Down

0 comments on commit ae7403e

Please sign in to comment.