Skip to content

Files

Latest commit

Dec 16, 2024
39ba27b · Dec 16, 2024

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Aug 24, 2021
Aug 24, 2021
Dec 16, 2024
Dec 16, 2024
Dec 16, 2024
May 15, 2023
May 15, 2023
Aug 24, 2021
Aug 24, 2021
Aug 24, 2021
Aug 24, 2021
Aug 24, 2021
Aug 24, 2021
Aug 24, 2021

Specification of NeuroMLlite v0.6.1

Note: the NeuroMLlite specification is still in development! Subject to change...

Network

A Network containing multiple Population's, connected by Projection's and receiving Input's

Allowed parameters

notes str
id str Unique identifier for the Network
parameters Any Dictionary of global parameters for the network
version str Information on verson of NeuroMLlite
seed int Seed for random number generator used when building network
temperature float Temperature at which to run network (float in deg C)
network_reader NetworkReader A class which can read in a network (e.g. from a structured format)

Allowed children

cells Cell The Cells which can be present in Populations
synapses Synapse The Synapse definitions which are used in Projections
input_sources InputSource The InputSource definitions which define the types of stimulus which can be applied in Inputs
regions RectangularRegion The Regions in which Populations get placed.
populations Population The Populations of Cells making up this network ...
projections Projection The Projections between Populations
inputs Input The inputs to apply to the elements of Populations

NetworkReader

A NetworkReader definition.

Allowed parameters

notes str
type str The type of NetworkReader
parameters Any Dictionary of parameters for the NetworkReader

Cell

A Cell definition.

Allowed parameters

notes str
id str Unique identifier for this Cell
parameters Any Dictionary of parameters for the cell
neuroml2_source_file str File name of NeuroML2 file defining the cell
lems_source_file str File name of LEMS file defining the cell
neuroml2_cell str Name of standard NeuroML2 cell type
pynn_cell str Name of standard PyNN cell type
arbor_cell str Name of standard Arbor cell type
bindsnet_node str Name of standard BindsNET node

Synapse

A Synapse definition.

Allowed parameters

notes str
id str Unique identifier for this Synapse
parameters Any Dictionary of parameters for the synapse
neuroml2_source_file str File name of NeuroML2 file defining the synapse
lems_source_file str File name of LEMS file defining the synapse
pynn_synapse_type str The pynn synapse type. Valid values are: "curr_exp", "curr_alpha", "cond_exp", "cond_alpha".
pynn_receptor_type str The pynn receptor type. Valid values are: "excitatory", "inhibitory".

InputSource

An InputSource definition.

Allowed parameters

notes str
id str Unique identifier for this InputSource
parameters Any Dictionary of parameters for the InputSource
neuroml2_source_file str File name of NeuroML2 file defining the input source
neuroml2_input str Name of standard NeuroML2 input
lems_source_file str File name of LEMS file defining the input source
pynn_input str Name of PyNN input

RectangularRegion

A RectangularRegion definition.

Allowed parameters

notes str
id str Unique identifier for this rectangular region.
x float x coordinate of corner of region
y float y coordinate of corner of region
z float z coordinate of corner of region
width float width of the rectangular region
height float height of the rectangular region
depth float depth of the rectangular region

Population

A Population definition.

Allowed parameters

notes str
id str Unique identifier for this Population
size Union[EvaluableExpression, List, Dict, ndarray, int, float, str] The size of the population.
component str The type of Cell to use in this population.
properties Any A dictionary of properties (metadata) for this population.
random_layout RandomLayout Layout in the random RectangularRegion.
relative_layout RelativeLayout Position relative to RectangularRegion.
single_location SingleLocation Explicit location of the one Cell in the population

RandomLayout

A RandomLayout definition.

Allowed parameters

notes str
region str Region in which to place population

RelativeLayout

A RelativeLayout definition.

Allowed parameters

notes str
region str The Region relative to which population should be positioned.
x float x position relative to x coordinate of Region
y float y position relative to y coordinate of Region
z float z position relative to z coordinate of Region

SingleLocation

A SingleLocation definition.

Allowed parameters

notes str
location Location Location of the single Cell.

Location

A Location definition.

Allowed parameters

notes str
x float x coordinate of location
y float y coordinate of location
z float z coordinate of location

Projection

A Projection definition.

Allowed parameters

notes str
id str Unique identifier for this Projection
presynaptic str Presynaptic Population
postsynaptic str Postsynaptic Population
synapse str Which Synapse to use
pre_synapse str For continuous connections, what presynaptic component to use (default: silent analog synapse)
type str type of projection: projection (default; standard chemical, event triggered), electricalProjection (for gap junctions) or continuousProjection (for analogue/graded synapses)
delay Union[EvaluableExpression, List, Dict, ndarray, int, float, str] Delay to use (default: 0)
weight Union[EvaluableExpression, List, Dict, ndarray, int, float, str] Weight to use (default: 1)
random_connectivity RandomConnectivity Use random connectivity
convergent_connectivity ConvergentConnectivity Use convergent connectivity
one_to_one_connector OneToOneConnector Connect cell index i in pre pop to cell index i in post pop for all i

RandomConnectivity

A RandomConnectivity definition.

Allowed parameters

notes str
probability Union[EvaluableExpression, List, Dict, ndarray, int, float, str] Random probability of connection.

ConvergentConnectivity

A ConvergentConnectivity definition.

Allowed parameters

notes str
num_per_post float Number per post-synaptic neuron.

OneToOneConnector

A OneToOneConnector definition.

Allowed parameters

notes str

Input

An Input definition.

Allowed parameters

notes str
id str Unique identifier for this Input
input_source str Type of input to use in population
population str Population to target
cell_ids Union[EvaluableExpression, List, Dict, ndarray, int, float, str] Specific ids of Cells to apply this input to (cannot be used with percentage
percentage Union[EvaluableExpression, List, Dict, ndarray, int, float, str] Percentage of Cells to apply input to
number_per_cell Union[EvaluableExpression, List, Dict, ndarray, int, float, str] Number of individual inputs per selected Cell (default: 1)
segment_ids Union[EvaluableExpression, List, Dict, ndarray, int, float, str] Which segments to target (default: [0])
weight Union[EvaluableExpression, List, Dict, ndarray, int, float, str] Weight to use (default: 1)