You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit cc7f020
Browse filesBrowse the repository at this point in the historyBrowse files
alt="Cleo: the Closed-Loop, Electrophysiology, and Optophysiology experiment simulation testbed">
17
16
</img>
18
17
</p>
19
18
</h1>
20
19
21
-
22
20
Hello there!
23
21
Cleo has the goal of bridging theory and experiment for mesoscale neuroscience, facilitating electrode recording, optogenetic stimulation, and closed-loop experiments (e.g., real-time input and output processing) with the [Brian 2](https://brian2.readthedocs.io/en/stable/) spiking neural network simulator.
24
22
We hope users will find these components useful for prototyping experiments, innovating methods, and testing observations about a hypotheses *in silico*, incorporating into spiking neural network models laboratory techniques ranging from passive observation to complex model-based feedback control.
25
23
Cleo also serves as an extensible, modular base for developing additional recording and stimulation modules for Brian simulations.
26
24
27
25
This package was developed by [Kyle Johnsen](https://kjohnsen.org) and Nathan Cruzado under the direction of [Chris Rozell](https://siplab.gatech.edu) at Georgia Institute of Technology.
28
-
See the preprint[here](https://www.biorxiv.org/content/10.1101/2023.01.27.525963).
26
+
See the publication[here](https://www.jneurosci.org/content/46/1/e2239242025).
Cleo provides functions for configuring electrode arrays and placing them in arbitrary locations in the simulation.
46
45
The user can then specify parameters for probabilistic spike detection or a spike-based LFP approximation developed by [Teleńczuk et al., 2020](https://www.sciencedirect.com/science/article/pii/S0165027020302946).
By modeling light propagation and opsins, Cleo enables users to flexibly add photostimulation to their model.
50
50
Both a four-state Markov state model of opsin kinetics is available, as well as a minimal proportional current option for compatibility with simple neuron models.
51
51
Cleo also accounts for opsin action spectra to model the effects of multi-light/wavelength/opsin crosstalk and heterogeneous expression.
@@ -57,14 +57,17 @@ Users can also inject a microscope into their model, selecting neurons on the sp
57
57
The calcium indicator model of [Song et al., 2021](https://www.sciencedirect.com/science/article/pii/S0165027021001084) is implemented, with parameters included for GCaMP6 variants.
58
58
59
59
## 🚀 Getting started
60
+
60
61
Just use pip to install—the name on PyPI is `cleosim`:
62
+
61
63
```bash
62
64
pip install cleosim
63
65
```
64
66
65
67
Then head to the [overview section of the documentation](https://cleosim.readthedocs.io/latest/overview.html) for a more detailed discussion of motivation, structure, and basic usage.
66
68
67
69
## 📚 Related resources
70
+
68
71
Those using Cleo to simulate closed-loop control experiments may be interested in software developed for the execution of real-time, *in-vivo* experiments.
69
72
Developed by members of [Chris Rozell](https://siplab.gatech.edu)'s and [Garrett Stanley](https://stanley.gatech.edu/)'s labs at Georgia Tech, the [CLOCTools repository](https://cloctools.github.io) can serve these users in two ways:
70
73
@@ -74,23 +77,25 @@ Although Cleo enables closed-loop manipulation of network simulations, it does n
74
77
The `ldsCtrlEst` library implements adaptive linear dynamical system-based control while the `hmm` library can generate and decode systems with discrete latent states and observations.
[**Cleo: A testbed for bridging model and experiment by simulating closed-loop stimulation, electrode recording, and optophysiology**](https://www.biorxiv.org/content/10.1101/2023.01.27.525963)<br>
[**CLOC Tools: A Library of Tools for Closed-Loop Neuroscience**](https://github.com/cloctools/tools-for-neuro-control-manuscript)<br>
90
+
[**Bridging Model and Experiment in Systems Neuroscience with Cleo: The Closed-Loop, Electrophysiology, and Optophysiology Simulation Testbed**](https://www.jneurosci.org/content/46/1/e2239242025)<br>
91
+
K.A. Johnsen, N.A. Cruzado, Z.C. Menard, A.A. Willats, A.S. Charles, J.E. Markowitz, and C.J. Rozell. *Journal of Neuroscience*, 2026.
92
+
93
+
<!-- THESE AREN'T PUBLICLY VIEWABLE -->
94
+
<!-- [**CLOC Tools: A Library of Tools for Closed-Loop Neuroscience**](https://github.com/cloctools/tools-for-neuro-control-manuscript)<br>
90
95
A.A. Willats, M.F. Bolus, K.A. Johnsen, G.B. Stanley, and C.J. Rozell. *In prep*, 2023.
91
96
92
97
[**State-Aware Control of Switching Neural Dynamics**](https://github.com/awillats/state-aware-control)<br>
93
-
A.A. Willats, M.F. Bolus, C.J. Whitmire, G.B. Stanley, and C.J. Rozell. *In prep*, 2023.
98
+
A.A. Willats, M.F. Bolus, C.J. Whitmire, G.B. Stanley, and C.J. Rozell. *In prep*, 2023.-->
94
99
95
100
[**Closed-Loop Identifiability in Neural Circuits**](https://github.com/awillats/clinc)<br>
96
101
A. Willats, M. O'Shaughnessy, and C. Rozell. *In prep*, 2023.
0 commit comments