Skip to content

Commit 908b4b5

Browse files
author
Chaitanya CHINTALURI
committed
updating readme with latest google collab links
1 parent 6676bae commit 908b4b5

2 files changed

Lines changed: 79 additions & 22 deletions

File tree

README.rst

Lines changed: 48 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,26 @@
11
Kernel Current Source Density
22
=============================
33

4-
This is the 2.0 version of kCSD inverse method proposed in
4+
This is python3 based library 2.0 version of kCSD inverse method proposed.
55

6-
J. Potworowski, W. Jakuczun, S. Łęski, D. K. Wójcik
7-
"Kernel Current Source Density Method"
8-
Neural Computation 24 (2012), 541–575
6+
1. J. Potworowski, W. Jakuczun, S. Łȩski, D. K. Wójcik
7+
"Kernel Current Source Density Method"
8+
Neural Comput 2012; 24 (2): 541–575.
9+
doi: https://doi.org/10.1162/NECO_a_00236
910

10-
For details see the `bioRxiv pre-print`_
11+
2. C. Chintaluri, M. Bejtka, W. Średniawa, M. Czerwiński, J. M. Dzik, J. Jędrzejewska-Szmek, K. Kondrakiewicz, E. Kublik, D. K. Wójcik
12+
"What we can and what we cannot see with extracellular multielectrodes"
13+
PLoS Computational Biology (2021), 17(5): e1008615.
14+
doi: https://doi.org/10.1371/journal.pcbi.1008615
1115

12-
.. _bioRxiv pre-print : https://doi.org/10.1101/708511
16+
3. C. Chintaluri, M. Bejtka, W. Średniawa, M. Czerwiński, J. M. Dzik, J. Jędrzejewska-Szmek, D. K. Wójck
17+
"kCSD-python, reliable current source density estimation with quality control"
18+
bioRxiv
19+
doi: https://doi.org/10.1101/708511
1320

21+
Paper 1 is the original paper with software code in Matlab.
22+
Paper 2 is an improvement and development of the paper 1.
23+
Paper 3 is a feature showcase and walk-through of the method and its applications.
1424

1525
Health Report
1626
-------------
@@ -30,7 +40,39 @@ Documentation Status:
3040
.. image:: https://readthedocs.org/projects/kcsd-python/badge/?version=latest
3141
:target: https://kcsd-python.readthedocs.io/en/latest/?badge=latest
3242

43+
Tutorials
44+
---------
3345

46+
This library comes with three tutorials that **do not require any installation**.
47+
48+
1. `Basic tutorial<https://colab.research.google.com/drive/1M7fCR5iZ9c7SAZWWoq9WLfFpk7pCaufd?usp=sharing>`_
49+
2. `Advanced tutorial<https://colab.research.google.com/drive/1gIuBJ2XzOGmgnRuxKguHevcYoE6eY_o1?usp=sharing>`_
50+
3. `sKCSD tutorial<https://colab.research.google.com/drive/1tjOvC5-OTteiGT_f-MBQ3hqN7P3i1P8e?usp=sharing>`_
51+
52+
More information on these **online only** tutorials is provided here `Tutorials!`_
53+
54+
.. _Tutorials!: /docs/source/TUTORIALS.rst
55+
56+
To have these tutorials and saved on your desktop, you will also need jupyter-notebook installed
57+
58+
.. code-block:: bash
59+
pip install jupyterlab
60+
61+
62+
Figures
63+
-------
64+
65+
This library includes all the necessary scripts to generate the figures for papers 2 and 3.
66+
67+
`Figures for Paper 2!`_
68+
69+
.. _Figures for Paper 2!: /figures/what_you_can_see_with_lfp/README.txt
70+
71+
`Figures for Paper 3!`_
72+
73+
.. _Figures for Paper 3!: /figures/kCSD_properties/README.txt
74+
75+
3476
Documentation
3577
-------------
3678

@@ -44,12 +86,6 @@ Also included here are installation instructions, authors and their
4486
contributions, citation policy, contacts etc.,
4587

4688

47-
Also included are `Tutorials!`_
48-
49-
.. _Tutorials!: /docs/source/TUTORIALS.rst
50-
51-
52-
5389
Earlier Stable versions
5490
-----------------------
5591
Please see git tags for earlier versions

docs/source/TUTORIALS.rst

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
Tutorials
22
---------
33

4-
kcsd-python library comes with two extensive tutorials (at this
4+
Online version
5+
6+
kcsd-python library comes with three extensive tutorials (at this
57
moment, more soon). These can be tested using Jupyter notebook on your
68
desktop after installing the kCSD-python package. Alternatively, they
7-
can be played around with without any installation on Binder in a
8-
web-browser. Note that in this case, the results from a browser are
9-
not saved, and cannot be retreived.
9+
can be played around with without any installation on Google collaboratory in a
10+
web-browser. **Note: the results from a browser are not saved, and cannot be retreived.**
1011

1112
Basic Features
1213
~~~~~~~~~~~~~~
@@ -22,11 +23,14 @@ and repeat the procedure. We also explore the situation when certain
2223
number of the electrode are broken, and how that would effect the
2324
reconstructions.
2425

25-
The tutorial is provided with Binder access, click the button below to
26+
The tutorial is provided with Google collaboratory, click the button below to
2627
interact with it in a browser, no installation necessary.
2728

28-
.. image:: https://mybinder.org/badge.svg
29-
:target: https://mybinder.org/v2/gh/Neuroinflab/kCSD-python/master?filepath=tutorials%2Ftutorial_basic.ipynb
29+
`Basic tutorial<https://colab.research.google.com/drive/1M7fCR5iZ9c7SAZWWoq9WLfFpk7pCaufd?usp=sharing>`_
30+
31+
..
32+
.. image:: https://mybinder.org/badge.svg
33+
:target: https://mybinder.org/v2/gh/Neuroinflab/kCSD-python/master?filepath=tutorials%2Ftutorial_basic.ipynb
3034
3135

3236
For a non-interactive version of this tutorial, see
@@ -47,16 +51,33 @@ Features tutorial and expands it to the other dimensions. NOTE, the
4751
user might have to 'Reset this tutorial' before using to enable the
4852
buttons (Kernel>Restart & Run All).
4953

50-
The tutorial is provided with Binder access, click the button below to
54+
The tutorial is provided with Google collaboratory, click the button below to
5155
interact with it in a browser, no installation necessary.
5256

53-
.. image:: https://mybinder.org/badge.svg
54-
:target: https://mybinder.org/v2/gh/Neuroinflab/kCSD-python/master?filepath=tutorials%2Ftutorial_advanced.ipynb
57+
`Advanced tutorial<https://colab.research.google.com/drive/1gIuBJ2XzOGmgnRuxKguHevcYoE6eY_o1?usp=sharing>`_
58+
59+
..
60+
.. image:: https://mybinder.org/badge.svg
61+
:target: https://mybinder.org/v2/gh/Neuroinflab/kCSD-python/master?filepath=tutorials%2Ftutorial_advanced.ipynb
5562
5663

5764
For a non-inteactive version of this tutorial, see
5865
`Tutorail2<https://github.com/Neuroinflab/kCSD-python/blob/master/tutorials/tutorial_advanced.ipynb>`_.
5966

67+
sKCSD Tutorial
68+
~~~~~~~~~~~~~~
69+
70+
This tutorial showcases the possibility to reconstruct the current sources
71+
of a single neuron provided the morphology of the said neuron is known.
72+
This methods has been described extensively here: https://doi.org/10.7554/eLife.29384
73+
74+
75+
`sKCSD tutorial<https://colab.research.google.com/drive/1tjOvC5-OTteiGT_f-MBQ3hqN7P3i1P8e?usp=sharing>`_
76+
77+
78+
For a non-inteactive version of this tutorial, see
79+
`sKCSD Tutorial<https://github.com/Neuroinflab/kCSD-python/blob/master/tutorials/skcsd_tutorial.ipynb>`_
80+
6081

6182
More Tutorials
6283
~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)