darela
Computational models to analyze FSCV traces of in vivo dopamine release
Science Score: 57.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 4 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.3%) to scientific vocabulary
Repository
Computational models to analyze FSCV traces of in vivo dopamine release
Basic Info
Statistics
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
DARELA: DA RELease Analysis
DARELA is a Python library that provides computational models written using differential equations to analyze and quantify the kinetics of dopamine (DA) release, reuptake, and diffusion. The models can be used to fit data from in vivo fast-scan cyclic voltammetry (FSCV) experiments.
For more details on how these computational models are derived, please refer to our paper.
Installation
Start by cloning this repo, then run:
pip install -e .
This will install a development copy of the library, which can be modified as needed.
The library requires autograd and alive-progress, which are automatically installed as dependencies if your Python setup does not have it.
Usage
There are three computational models provided with this library: the Simple Uniform Release (SUR) model, Spatiotemporal Uniform Release (STUR) model, and Spatiotemporal Discrete Release (STDR) model.
Step 1. Model Initialization
To initialize the SUR model, run:
``` from darela import SUR
model = SUR() model.initialize(bursts, f, NP, I) model.loss(L) ```
To initialize the STUR model, run:
``` from darela import STUR
model = STUR() model.initialize(bursts, f, NP, I) model.geometry(Rl, Rd) ```
To initialize the STDR model, run:
``` from darela import STDR
model = STDR() model.initialize(bursts, f, NP, I) model.geometry(Rl, Rd) model.release_sites(locs) ```
bursts: a list of start times for the bursts in an FSCV experimentf: stimulus frequency (in Hz)NP: number of pulses per burstI: stimulus current (in mA)L: loss factor of DARl: radius of the cylinder (in μm)Rd: radius of the dead space (in μm)locs: a list of discrete release site locations in the striatum
Step 2: Parameter Initialization
To initialize release and kinetic parameters, load each set of parameters in a dictionary and call the corresponding model functions:
``` release = { ... }
kinetics = { ... }
model.releaseparams(release) model.kineticparams(kinetics) ```
For more information on the list of available parameters, please check the Model Parameters section of this README.
Step 3: Model Solving
To simulate the model output with the specified experiment, release, and kinetic parameters, run:
model.solve(t)
t: 1Dnp.ndarraytime-series.
Step 3A: Parameter Estimation
This library comes with a built-in parameter estimation algorithm to find the closest fit parameters to an FSCV trace. To fit the model to the data, run:
model.fit(y, t, params)
- y: 1D np.ndarray containing FSCV data points
- t: 1D np.ndarray containing corresponding time points
- params: a list of parameters (release or kinetic) to fit to the data.
Examples
For detailed examples on how to use this library, please check the examples directory.
Model Parameters
Release parameters:
Vm: maximum velocity of DAT uptake (μM/s)Km: affinity (binding) constant of DAT uptake (μM)DAp: amount of DA release per pulse (μM/mA)kS: rate transfer of DA from striatum to electrodekE: rate transfer of DA from electrode back to striatumkads1: adsorption kinetic of DAkads2: desorption kinetic of DAkads3: desorption kinetic 2 of DA
Kinetic parameters:
ktypes: a list of kinetic types with four possible values:stf: short-term facilitationstd: short-term depressionltf: long-term facilitationltd: long-term depression
p: a list of plasticity factors for each kinetic- Facilitation:
p> 0 - Depression:
p< 0
- Facilitation:
tau: a list of time constants for each kinetic- Short-Term: 5 <
tau< 50 - Long-Term: 600 <
tau< 1200
- Short-Term: 5 <
Citing DARELA
If you find this library useful in your research, please cite our paper:
N Shashaank, M Somayaji, M Miotto, EV Mosharov, EA Makowicz, DA Knowles, G Ruocco, DL Sulzer. 2023. Computational models of dopamine release measured by fast scan cyclic voltammetry in vivo. PNAS Nexus 2(3). https://doi.org/10.1093/pnasnexus/pgad044
Owner
- Name: Sulzer Lab @ Columbia University
- Login: DSulzerLab
- Kind: organization
- Repositories: 1
- Profile: https://github.com/DSulzerLab
Citation (CITATION.cff)
cff-version: 1.2.0
message: >-
If you use this software, please cite it as below.
type: software
authors:
- given-names: 'N'
family-names: Shashaank
title: "DARELA"
version: 1.0
preferred-citation:
type: article
authors:
- given-names: 'N'
family-names: Shashaank
- given-names: Mahalakshmi
family-names: Somayaji
- given-names: Mattia
family-names: Miotto
- given-names: "Eugene V."
family-names: Mosharov
- given-names: "Emily A."
family-names: Makowicz
- given-names: "David A."
family-names: Knowles
- given-names: Giancarlo
family-names: Ruocco
- given-names: "David L."
family-names: Sulzer
doi: 10.1093/pnasnexus/pgad044
journal: "PNAS Nexus"
volume: 2
issue: 3
month: 3
title: >-
Computational models of dopamine release measured by fast scan cyclic voltammetry in vivo
year: 2023
GitHub Events
Total
- Watch event: 1
- Push event: 1
Last Year
- Watch event: 1
- Push event: 1