Neurodamus is a BBP Simulation Control application for Neuron.

The Python implementation offers a comprehensive Python API for fine tunning of the simulation, initially defined by a BlueConfig file.

Neurodamus is the BBP in-house developed application for setting up large-scale neuronal simulations. It has traditionally been implemented as a set of extensions to Neuron, in the form of .hoc and .mod files. The parameters of the simulation are loaded from a configuration file, by default BlueConfig.

To address several limitations of the Hoc implementation, including development effort, the high-level layers of Neurodamus have been reimplemented in Python. Such implementation effectively makes available to the user a Python module with a comprehensive API, suitable to fine control simulation aspects, as well as inspect and eventually adapt the simulations as intended.

• hdf5
• libsonatareport https://github.com/BlueBrain/libsonatareport
• neuron with MPI https://github.com/neuronsimulator/nrn

git clone https://github.com/BlueBrain/neurodamus.git
cd neurodamus
pip install .

mkdir mods
cp -r mod-files-from-released-circuit mods/
cp -r neurodamus-install-prefix/share/mod/* mods/
nrnivmodl -incflags '-I <include-paths-of-our-dependencies>' -loadflags '-L <libs-paths-for-linking>'' mod

Once installed, you should be able to find neurodamus in your path:

$ neurodamus
  Usage:
      neurodamus <ConfigFile> [options]
      neurodamus --help

Among the options you will find flags to tune run behavior.

Neurodamus explicitly depends on MPI libraries for parallel execution. Therefore please use "srun" or "mpiexec" to launch it, according to your platform. If you don't, complicated error messages may show up. Please remember it.

Even though a neurodamus launcher is provided, for production runs we suggest using special instead. This way has proven to take advantage of optimized math libraries. We hope to bring the same advantages to the launcher script soon.

srun <srun params> <your_built_special> -mpi -python $NEURODAMUS_PYTHON/init.py <neurodamus params>

An example of a full installation with a simulation run can be found in the workflow test simulation_test.yaml.

The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government's ETH Board of the Swiss Federal Institutes of Technology.

Copyright (c) 2005-2023 Blue Brain Project/EPFL