Skip to content

Commit 41f77e4

Browse files
author
Chaitanya CHINTALURI
committed
refinements to readme
1 parent d0dff67 commit 41f77e4

2 files changed

Lines changed: 48 additions & 24 deletions

File tree

README.rst

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,25 @@ This 2.0 version of kCSD inverse method proposed in python3
66
Relevant Papers
77
---------------
88

9-
#. J. Potworowski, W. Jakuczun, S. Łȩski, D. K. Wójcik
10-
"Kernel Current Source Density Method"
11-
Neural Comput 2012; 24 (2): 541–575.
12-
doi: https://doi.org/10.1162/NECO_a_00236
9+
Paper 1
1310

14-
#. C. Chintaluri, M. Bejtka, W. Średniawa, M. Czerwiński, J. M. Dzik, J. Jędrzejewska-Szmek, K. Kondrakiewicz, E. Kublik, D. K. Wójcik
15-
"What we can and what we cannot see with extracellular multielectrodes"
16-
PLoS Computational Biology (2021), 17(5): e1008615.
17-
doi: https://doi.org/10.1371/journal.pcbi.1008615
11+
J. Potworowski, W. Jakuczun, S. Łȩski, D. K. Wójcik
1812

19-
#. C. Chintaluri, M. Bejtka, W. Średniawa, M. Czerwiński, J. M. Dzik, J. Jędrzejewska-Szmek, D. K. Wójck
20-
"kCSD-python, reliable current source density estimation with quality control"
21-
bioRxiv
22-
doi: https://doi.org/10.1101/708511
13+
"Kernel Current Source Density Method", Neural Comput 2012; 24 (2): 541–575, doi: https://doi.org/10.1162/NECO_a_00236
2314

15+
----
16+
Paper 2
17+
18+
C. Chintaluri, M. Bejtka, W. Średniawa, M. Czerwiński, J. M. Dzik, J. Jędrzejewska-Szmek, K. Kondrakiewicz, E. Kublik, D. K. Wójcik
19+
20+
"What we can and what we cannot see with extracellular multielectrodes", PLoS Computational Biology (2021), 17(5): e1008615, doi: https://doi.org/10.1371/journal.pcbi.1008615
21+
----
22+
Paper 3
23+
24+
C. Chintaluri, M. Bejtka, W. Średniawa, M. Czerwiński, J. M. Dzik, J. Jędrzejewska-Szmek, D. K. Wójck
25+
26+
"kCSD-python, reliable current source density estimation with quality control", bioRxiv, doi: https://doi.org/10.1101/708511
27+
----
2428

2529
Paper 1 is the original paper with software code in Matlab.
2630
Paper 2 is an improvement and development of the paper 1.

docs/source/TUTORIALS.rst

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

4-
Online version
4+
kcsd-python library comes with three extensive tutorials. These
5+
tutorials can be explored online or installed on your desktop computer
6+
depending on your usage. To simple test it out try the online version
7+
first, and if required install the python package.
8+
9+
**Online version**
10+
11+
To play around with the library without any installation, you can run
12+
the tutorials on Google collaboratory in a web-browser. **Note:** the
13+
results from a browser are not saved and cannot be retreived. If you
14+
wish to have the results stored somewhere, please use the desktop
15+
version.
16+
17+
**Desktop version**
18+
19+
This requires you to install the kCSD-package and additionally to
20+
install jupyter notebook on your desktop.
21+
22+
.. code-block:: bash
23+
24+
git clone https://github.com/Neuroinflab/kCSD-python.git
25+
cd kCSD-python
26+
pip install .
27+
pip install jupyterlab
28+
29+
530
6-
kcsd-python library comes with three extensive tutorials (at this
7-
moment, more soon). These can be tested using Jupyter notebook on your
8-
desktop after installing the kCSD-python package. Alternatively, they
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.**
1131
1232
Basic Features
1333
~~~~~~~~~~~~~~
@@ -26,15 +46,15 @@ reconstructions.
2646
The tutorial is provided with Google collaboratory, click the button below to
2747
interact with it in a browser, no installation necessary.
2848

29-
`Basic tutorial<https://colab.research.google.com/drive/1M7fCR5iZ9c7SAZWWoq9WLfFpk7pCaufd?usp=sharing>`_
49+
`Basic tutorial <https://colab.research.google.com/drive/1M7fCR5iZ9c7SAZWWoq9WLfFpk7pCaufd?usp=sharing>`_
3050

3151
..
3252
.. image:: https://mybinder.org/badge.svg
3353
:target: https://mybinder.org/v2/gh/Neuroinflab/kCSD-python/master?filepath=tutorials%2Ftutorial_basic.ipynb
3454
3555

3656
For a non-interactive version of this tutorial, see
37-
`Tutorail1<https://github.com/Neuroinflab/kCSD-python/blob/master/tutorials/tutorial_basic.ipynb>`_.
57+
`Tutorail1 <https://github.com/Neuroinflab/kCSD-python/blob/master/tutorials/tutorial_basic.ipynb>`_.
3858

3959

4060

@@ -54,15 +74,15 @@ buttons (Kernel>Restart & Run All).
5474
The tutorial is provided with Google collaboratory, click the button below to
5575
interact with it in a browser, no installation necessary.
5676

57-
`Advanced tutorial<https://colab.research.google.com/drive/1gIuBJ2XzOGmgnRuxKguHevcYoE6eY_o1?usp=sharing>`_
77+
`Advanced tutorial <https://colab.research.google.com/drive/1gIuBJ2XzOGmgnRuxKguHevcYoE6eY_o1?usp=sharing>`_
5878

5979
..
6080
.. image:: https://mybinder.org/badge.svg
6181
:target: https://mybinder.org/v2/gh/Neuroinflab/kCSD-python/master?filepath=tutorials%2Ftutorial_advanced.ipynb
6282
6383

6484
For a non-inteactive version of this tutorial, see
65-
`Tutorail2<https://github.com/Neuroinflab/kCSD-python/blob/master/tutorials/tutorial_advanced.ipynb>`_.
85+
`Tutorail2 <https://github.com/Neuroinflab/kCSD-python/blob/master/tutorials/tutorial_advanced.ipynb>`_.
6686

6787
sKCSD Tutorial
6888
~~~~~~~~~~~~~~
@@ -72,11 +92,11 @@ of a single neuron provided the morphology of the said neuron is known.
7292
This methods has been described extensively here: https://doi.org/10.7554/eLife.29384
7393

7494

75-
`sKCSD tutorial<https://colab.research.google.com/drive/1tjOvC5-OTteiGT_f-MBQ3hqN7P3i1P8e?usp=sharing>`_
95+
`sKCSD tutorial <https://colab.research.google.com/drive/1tjOvC5-OTteiGT_f-MBQ3hqN7P3i1P8e?usp=sharing>`_
7696

7797

7898
For a non-inteactive version of this tutorial, see
79-
`sKCSD Tutorial<https://github.com/Neuroinflab/kCSD-python/blob/master/tutorials/skcsd_tutorial.ipynb>`_
99+
`sKCSD Tutorial <https://github.com/Neuroinflab/kCSD-python/blob/master/tutorials/skcsd_tutorial.ipynb>`_
80100

81101

82102
More Tutorials

0 commit comments

Comments
 (0)