Commit 74fa8151 authored by Sophia Ohnemus's avatar Sophia Ohnemus
Browse files

Upload Readme

parent 9f41ba75
Loading
Loading
Loading
Loading

Readme.md

0 → 100644
+44 −0
Original line number Diff line number Diff line
# Experimentally informed, quantitative photocycle model of the light-gated potassium channel WiChR


Here we provide source code for the first experimentally validated photocycle model of the potassium conducting Wobblia inhibitory channelrhodopsin (WiChR). Detailed information on model development can be found at XY.

## Environments

>Python = 3.9
>
>matplotlib = 3.6.3
>
>numpy = 1.23.5
> 
>scipy = 1.10.0


## Examples

To plot the WiChR current at 40 mV for 500 ms illumination with 4 mW/mm^2, given a whole-cell conductance of 4 nS/pF and a cell with 1.6 pl volume and 25.6 pF membrane capacitance, run:

>`time, I_WiChR = simulate_WiChR(40, 4, 500, 4, 1.6e-12, 25.6e-12)`
> 
>`plt.plot(time, I_WiChR)`
> 
> `plt.ylabel('I (pA/pF)')`
> 
> `plt.xlabel('t (ms)')`
> 
> `plt.show()`

If the photocurrent should be calculated with the two-branch model, use the option model='two-branch':

>`time, I_WiChR = simulate_WiChR(40, 4, 500, 4, 1.6e-12, 25.6e-12, model='two-branch')`
> 
>`plt.plot(time, I_WiChR)`
> 
> `plt.ylabel('I (pA/pF)')`
> 
> `plt.xlabel('t (ms)')`
> 
> `plt.show()`
>