Skip to content

latimerb/BRAIN_Project4

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BLA: a NEURON network model

This is a large-scale biophysical network model of the Basolateral Amygdala based on the framework provided by Marianne Bezaire's moddel of the hippocampal CA1 area.

Bezaire et al. (2016) Interneuronal mechanisms of hippocampal theta oscillations in a full-scale model of the rodent CA1 circuit. eLife.

Main features

  • Linux, Mac OS X and Windows support
  • Documentation

Documentation ============ Full documentation is available here.

Installation

macOS

On macOS, ca1 code can be installed via Homebrew (recommended):

$ brew install ...

A MacPorts port is also available:

$ port install ...

Linux

# Debian, Ubuntu, etc. using Docker
$ apt-get install ....
# FDebian, Ubuntu, etc.  manual install
$ yum install ...

Windows, etc.

A universal installation method (that works on Windows, Mac OS X, Linux, …, and always provides the latest version) is to use pip:

# Make sure we have an up-to-date version of pip and setuptools:
$ pip install --upgrade pip setuptools

$ pip install --upgrade ...

(If pip installation fails for some reason, you can try easy_install ... as a fallback.)

Usage

Scaled-down model:

$ nrngui main.hoc # Runs a network at scale 1:10000 for 100 ms to ensure all works

# OR

$ nrngui -c "SimDuration=600" main.hoc -c "quit()" # Runs a network at scale 1:10000 for 600 ms, long enough to see theta emerge

# OR

$ nrngui -nopython ... # if there is no python installed

# OR

$ nrniv ... # if using without a GUI popup (depends on your NEURON installation; sometimes nrngui must be invoked to ensure all necessary libraries are loaded when NEURON launches)

Synopsis:

$ nrngui [-c parameters] [main.hoc file]  -c "quit()"  # adding the quit() command after ensures the code stops immediately after an error

See also nrngui help.

Examples

Scaled down model to run directly on a personal computer:

$ nrngui main.hoc # Runs a network at scale 1:10000 for 100 ms to ensure all works

# OR

$ nrngui -c "Scale=1000" -c "SimDuration=600" main.hoc -c "quit()" # Runs a network at scale 1:1000 (will take a long time) for 600 ms, long enough to see theta emerge

# OR

$ nrngui -nopython -c "SimDuration=1000"  -c "ConnData=446" main.hoc -c "quit()" # try a different connectivity configuration and a longer simulation with the default Scale of 1:10000, use the nopython flag if NEURON has errors due to not finding the site module, etc.

# OR

$ nrngui -c "Scale=1" main.hoc -c "quit()" # run a full scale network - this is not feasible for the ca1 network on a personal computer, but could be used for tiny networks such as ringdemo.

On a supercomputer, after creating a submission jobscript and moving to the model repository directory, enter:

$ sbatch ./jobscripts/MyTestRun.sh

# OR

$ qsub ./jobscripts/MyTestRun.sh

According to the batch queueing software used by the computer. Or, use SimTracker to create the jobscript, export the script, code, and parameter sets to the supercomputer, and submit the job request to the queue.

Environment variables =======

You may wish to set...

In your ~/.bash_profile:

export N=samplesample
export NEURONHOME=samplesample
export PYTHONPATH=samplesample

Outputs

The result files output from each run include certain files that are always written as well as optional results files:

spikerast.dat All spike times and gids of spiking cells.
numcons.dat Su mmary of number of connections between each pre and post cell type, on each processor.
connections.dat

Detailed list of every synapse in model.

Customizing =========

To run this code with different parameters:

#!/bin/bash

nrngui [-c "Parameter=Value"]  [-c "strdef StringParam" "StringParam=\"StringValue\""]   ...

To run a network clamp simulation:

#!/bin/bash

nrngui -nopython -c gidOI=21310 -c cellindOI=6 -c stimflag=0 -c "strdef runname" -c runname="\"ca1_1x_exc_08\""  -c "strdef origRunName" -c origRunName="\"ca1_1x_exc_08\""  -c "strdef celltype2use" -c celltype2use="\"poolosyncell\""     -c "strdef resultsfolder" -c resultsfolder="\"00001\"" ./networkclamp_results/ca1_1x_exc_08/00001/run.hoc -c "quit()"

To customize this code...

Best practices

The blah blah blah.

Meta

Interface design

Blah blah.

User support

Please use the following support channels:

Dependencies

ca1 uses NEURON with HOC:

  • Requests — Python HTTP library for humans
  • Pygments — Python syntax highlighter

ca1 friends

ca1 can be used with:

Alternatives

  • ModelDB — ModelDB contains many NEURON models and other neuroscience simulator models for various networks and cell types.

Citation -------

Please cite this code if you use it or derive a model from it, using the most appropriate citation below:

License

CC0 1.0 Universal (CC0 1.0): Public Domain Dedication

For more information, see the CC0 Description.

CC0 License

Authors

Marianne Bezaire created the ca1 model with help from:

  • Ivan Raikov
  • Padraig Gleeson
  • Andras Ecker
  • Kelly Burk
  • Michael Hines
  • Ted Carnevale
  • Ivan Soltesz

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published