This page documents various conventions in use in NeuroML.
Prefer underscores instead of spaces#
In general, please prefer underscores
_ instead of spaces wherever possible, in filenames and ids.
Component IDs: NmlId#
Some Components take an
id parameter of type
NmlId to set an ID for them.
They can then be referred to using their IDs when constructing paths and so on.
IDs of type
NmlId in NeuroML are strings and have certain constraints:
they must start with an alphabet (either small or capital) or an underscore
they may include alphabets, both small and capital letters, numbers and underscores
IDs are also checked during validation, so if an ID does not follow these constraints, the validation will throw an error.
When naming different NeuroML files, we suggest the following suffixes:
channel.nmlfor NeuroML files describing ion channels, for example:
cell.nmlfor NeuroML files describing cells, for example:
synapse.nmlfor NeuroML files describing synapses, for example:
net.nmlfor NeuroML files describing networks of cells, for example:
For LEMS files that describe simulations of NeuroML models (“LEMS Simulation files”), we suggest that:
file names start with the
file names end in
When naming segments in multi-compartmental neuron models, we suggest the following prefixes:
axon_for axonal segments
dend_for dendritic segments
soma_for somatic segments
There are 3 specific recommended names for segment groups which contain ALL of the somatic, dendritic or axonal segments
axon_groupfor the group of all axonal segments
dendrite_groupfor the group of all dendritic segments
soma_groupfor the group of all somatic segments
Ideally every segment should be a member of one and only one of these groups.