Debian Codegraph @

docs/autodocs/source/bionet_config.rst

raw
1 :orphan:
2
3 Configuration file
4 ==================
5
6 The configuration file defines the files describing the network, its input as well as run-time parameters. For convenience it is grouped into the following categories:
7
8
9 Manifest
10 ++++++++
11
12 Includes custom path variables that may be used to build full paths to files. The special variable "${configdir}" in the "$BASE_DIR" stands for the directory where the configuration file is located. Users may specify any valid directory for "$BASE_DIR" as well.
13
14
15 ::
16
17 "manifest": {
18 "$BASE_DIR": "${configdir}",
19 "$OUTPUT_DIR": "$BASE_DIR/output",
20 "$INPUT_DIR": "$BASE_DIR/../../NWB_files",
21 "$NETWORK_DIR": "$BASE_DIR/network",
22 "$COMPONENT_DIR":"$BASE_DIR/../components"
23 },
24
25
26 Run
27 +++
28
29 Includes run-time parameters
30
31 ::
32
33 "run": {
34 "tstop":3000.0, # run time (ms)
35 "dt": 0.1, # time step (ms)
36 "dL": 20, # length of compartments (i.e., segments) (um)
37 "overwrite_output_dir": true, # if True: will overwrite the output directory; if False: will issue an error that directory exists
38 "spike_threshold": -15, # will record a spike when membrane voltage (mV) is exceeded
39 "nsteps_block":5000, # will write to disk data after this many steps
40 "save_cell_vars": ["v", "cai"], # save somatic variables in the list
41 "calc_ecp": true # calculate ExtraCellular Potential (ECP): True or False
42 },
43
44
45 Conditions
46 ++++++++++
47
48 Includes information about the initial conditions:
49
50 ::
51
52
53 "conditions": {
54 "celsius": 34.0, # temperature (C)
55 "v_init": -80 # initial membrane voltage (mV)
56 },
57
58
59 Node_id selections
60 ++++++++++++++++++
61
62 Defines selections of cells. For example, this way can specify the cells (node_ids) for which variables will be saved
63
64 ::
65
66 "node_id_selections": {
67 "save_cell_vars": [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100]
68 },
69
70
71 Input
72 +++++
73
74 Defines spike_trains for the external inputs
75
76
77 ::
78
79 "input": [
80 {
81 "type": "external_spikes",
82 "format": "nwb",
83 "file": "$INPUT_DIR/lgn_spikes.nwb",
84 "source_nodes": "LGN",
85 "trial": "trial_0"
86 },
87 ...
88 ]
89
90 Output
91 ++++++
92
93 Defines file names for the output
94
95
96 ::
97
98 "output": {
99 "log_file": "$OUTPUT_DIR/log.txt", # log file
100 "spikes_ascii_file": "$OUTPUT_DIR/spikes.txt", # file for spikes in ascii format
101 "spikes_hdf5_file": "$OUTPUT_DIR/spikes.h5", # file for spikes in HDF5 format
102 "cell_vars_dir": "$OUTPUT_DIR/cellvars", # folder to save variables from individual cells
103 "ecp_file": "$OUTPUT_DIR/ecp.h5", # file to save extracellular potential
104 "output_dir": "$OUTPUT_DIR" # output directory
105 },
106
107
108
109
110 Components
111 ++++++++++
112
113 The "components" grouping includes paths to directories containing building blocks of a network model
114
115 ::
116
117 "components": {
118 "morphologies_dir": "$COMPONENT_DIR/biophysical/morphology", # morphologies
119 "synaptic_models_dir": "$COMPONENT_DIR/synaptic_models", # synaptic models
120 "mechanisms_dir": "$COMPONENT_DIR/mechanisms", # NEURON mechanisms
121 "biophysical_neuron_models_dir":"$COMPONENT_DIR/biophysical/electrophysiology", # parameters of biophysical models
122 "point_neuron_models_dir": "$COMPONENT_DIR/intfire", # parameters of point neuron models
123 "templates_dir": "$COMPONENT_DIR/hoc_templates" # NEURON HOC templates
124 },
125
126
127 Recording Extracellular Electrode
128 +++++++++++++++++++++++++++++++++
129
130 Includes parameters defining extracellular electrodes
131
132
133 ::
134
135 "recXelectrode": {
136 "positions": "$COMPONENT_DIR/recXelectrodes/linear_electrode.csv"
137 },
138
139
140
141
142 Networks
143 ++++++++
144
145 Includes files defining nodes and edges:
146
147 ::
148
149 "networks": {
150 "nodes": [
151 {
152 "name": "V1",
153 "nodes_file": "$NETWORK_DIR/v1_nodes.h5",
154 "node_types_file": "$NETWORK_DIR/v1_node_types.csv"
155 },
156 ...
157 ],
158
159 "edges": [
160 {
161 "target": "V1",
162 "source": "V1",
163 "edges_file": "$NETWORK_DIR/v1_v1_edges.h5",
164 "edge_types_file": "$NETWORK_DIR/v1_v1_edge_types.csv"
165 },
166 ...
167 ]
168 }
169
170