Skip to main content

kernel current source density methods

Project description

This 2.0 version of kCSD method.

Only supported for python 3.

Relevant Papers

Paper 1: “Kernel Current Source Density Method”, J. Potworowski, W. Jakuczun, S. Łȩski, D. K. Wójcik; Neural Comput 2012; 24 (2): 541–575, doi: https://doi.org/10.1162/NECO_a_00236

Paper 2 : “What we can and what we cannot see with extracellular multielectrodes”, C. Chintaluri, M. Bejtka, W. Średniawa, M. Czerwiński, J. M. Dzik, J. Jędrzejewska-Szmek, K. Kondrakiewicz, E. Kublik, D. K. Wójcik; PLoS Computational Biology (2021), 17(5): e1008615, doi: https://doi.org/10.1371/journal.pcbi.1008615

Paper 3 : “kCSD-python, reliable current source density estimation with quality control”, C. Chintaluri, M. Bejtka, W. Średniawa, M. Czerwiński, J. M. Dzik, J. Jędrzejewska-Szmek, D. K. Wójcik; bioRxiv, doi: https://doi.org/10.1101/708511

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

Tutorials

This library comes with three tutorials and does not require any installation.

  1. Basic tutorial

  2. Advanced tutorial

  3. sKCSD tutorial

More information on the tutorials is provided here Tutorials!

You can also save these tutorials on your desktop, for this you will need to install jupyter-notebook. Do this by

pip install jupyter notebook

Figures

This library includes all the necessary scripts to generate the figures for papers 2 and 3.

Figures for Paper 2

Figures for Paper 3

Installation

user:~/$ pip install kcsd

More Installations

Documentation

Autogenerated documentation available from readthedocs:

kCSD-python_Reference

Also included here are authors and their contributions, citation policy, contacts etc.,

Earlier Stable versions

Please see git tags for earlier versions. These are not available as packages unfortunately.

  • v1.2 corresponds to the first time kCSD-python released as a python package

  • v1.0 corresponds to the version with the test cases written inside tests folder

  • v1.1 corresponds to the elephant python library version - no tests here

Health Report

Continuous Integration (Travis):

https://travis-ci.org/Neuroinflab/kCSD-python.png?branch=master

Test Coverage :

https://coveralls.io/repos/github/Neuroinflab/kCSD-python/badge.png?branch=master

Documentation Status:

https://readthedocs.org/projects/kcsd-python/badge/?version=latest

License

Modified BSD License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kcsd-2.0.1.tar.gz (3.1 MB view details)

Uploaded Source

Built Distribution

kcsd-2.0.1-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

Details for the file kcsd-2.0.1.tar.gz.

File metadata

  • Download URL: kcsd-2.0.1.tar.gz
  • Upload date:
  • Size: 3.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for kcsd-2.0.1.tar.gz
Algorithm Hash digest
SHA256 5bdc4a03faa5ac2c5de1925d41ad04c72a18be4d764d0f177c0a75bb946a6871
MD5 3eab2bbaa213d52eac9dee0fdd144e47
BLAKE2b-256 300a2cf2ab8ac1bb380be47230d80cd7f404ec97ec692369c16a5670b6a94ae7

See more details on using hashes here.

File details

Details for the file kcsd-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: kcsd-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 1.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for kcsd-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7ca13392279876b684482eb0ec78764274c568e73f1f7596158dcbe487d26ef5
MD5 f1b5d176e05c72f3d134e02d30d08847
BLAKE2b-256 be7d19b723e1d03881b1d0542d0a0a8a062acd32af9d7bcf973c057f687044c7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page