Providing information about programs¶
The programs module handles simulator and analysis programs, i.e. executable files, to support the ability to customize Sumatra’s behaviour for specific tools.
Classes¶
- Executable
- represents a generic executable, about which nothing is known except its name. The base class for specific simulator/analysis tool classes.
- PythonExecutable
- represents the Python interpreter executable.
- MatlabExecutable
- represents the Matlab interpreter executable.
- NESTSimulator
- represents the NEST neuroscience simulator.
- NEURONSimulator
- represents the NEURON neuroscience simulator.
- GENESISSimulator
- represents the GENESIS neuroscience simulator.
Functions¶
- get_executable()
- Return an appropriate subclass of Executable, given either the path to an executable file or a script file that can be run with a given tool.
- register_executable()
- Register new subclasses of Executable that can be returned by get_executable().
-
class
sumatra.programs.
Executable
(path, version=None, options='', name=None)¶ Bases:
object
-
name
= None¶
-
requires_script
= False¶
-
static
write_parameters
(parameters, filebasename)¶
-
-
sumatra.programs.
get_executable
(path=None, script_file=None)¶ Given the path to an executable, determine what program it is, if possible. Given the name of a script file, try to infer the program that runs that script. Return an appropriate subclass of Executable
-
sumatra.programs.
register_executable
(cls, name, executables, extensions)¶ Register a new subclass of Executable that can be returned by get_executable().