hbp_nrp_commons.generated.bibi_api_gen module

class BIBIConfiguration(*args, **kw)

Bases: pyxb.binding.basis.complexTypeDefinition

This class represents the root of the BIBI configuration.

property bodyModel

The path to the robot model that should be used. This can either be a path to an SDF model or a path to a zip file containing all required assets for a robot. This zip file must have a file model.sdf at the root of the archive.

property brainModel

The brain model depicts a path to the neural network model.

property configuration

The configuration entries of an experiment depict additional files required for the simulation of experiments using this BIBI configuration.

property extRobotController

A path to an external robot controller. If specified, the robot controller is started when the simulation begins and stopped when the simulation is over. Therefore, the path must be a path to a shell script that offers a function start and a function stop.

property mode

The simulation mode. This determines the choice of the neural network simulator.

property timestep

If specified, the CLE uses a different timestep than the default timestep of 20ms. The timestep is specified in milliseconds and depicts the time between two successive loops of the CLE in simulation time.

property transferFunction

The transfer functions that are used to couple a neural network to robot

class BrainFilename(*args, **kw)

Bases: pyxb.binding.basis.STD_union

This denotes the supported file types for neural network models. The current version only supports Python or H5 files for neural networks.

class BrainModel(*args, **kw)

Bases: pyxb.binding.basis.complexTypeDefinition

A neural network description as used in the CLE

property file

A path to the neural network file.

property populations

The populations in this field are the explicitly defined populations. Each of this population is defined as a view of an assumed ‘circuit’ population.

class BrainModelWithPath(*args, **kw)

Bases: hbp_nrp_commons.generated.bibi_api_gen.BrainModel

Complex type {http://schemas.humanbrainproject.eu/SP10/2014/BIBI}BrainModelWithPath with content type ELEMENT_ONLY

property model

Get the value of the attribute from the instance.

class ConfFile(*args, **kw)

Bases: pyxb.binding.basis.complexTypeDefinition

This type denotes an additional configuration entry that consists of a file and a purpose.

property src

The source of a configuration entry is a path to a file that contains the necessary information. The path is relative to the BIBI model.

property type

The type of a configuration entry denotes the purpose how this entry is used. This is used to decouple the purpose of a configuration entry from the file name.

class ConfType(*args, **kw)

Bases: pyxb.binding.basis.STD_union

This type denotes a configuration type which can be a standard configuration type or a custom type. The latter is just any string.

brainvisualizer = 'brainvisualizer'

retina = 'retina'

class ConfTypeEnumeration(*args, **kw)

Bases: pyxb.binding.datatypes.string, pyxb.binding.basis.enumeration_mixin

This enumeration lists the standard configuration types used in the NRP.

brainvisualizer = 'brainvisualizer'

retina = 'retina'

CreateFromDOM(node, default_namespace=None)

Create a Python instance from the given DOM node. The node tag must correspond to an element declaration in this module.

@deprecated: Forcing use of DOM interface is unnecessary; use L{CreateFromDocument}.

CreateFromDocument(xml_text, default_namespace=None, location_base=None)

Parse the given XML and use the document element to create a Python instance.

@param xml_text An XML document. This should be data (Python 2 str or Python 3 bytes), or a text (Python 2 unicode or Python 3 str) in the L{pyxb._InputEncoding} encoding.

@keyword default_namespace The L{pyxb.Namespace} instance to use as the default namespace where there is no default namespace in scope. If unspecified or C{None}, the namespace of the module containing this function will be used.

@keyword location_base: An object to be recorded as the base of all L{pyxb.utils.utility.Location} instances associated with events and objects handled by the parser. You might pass the URI from which the document was obtained.

class H5Filename(*args, **kw)

Bases: pyxb.binding.datatypes.string

This type denotes a path to an H5 file.

class Index(*args, **kw)

Bases: hbp_nrp_commons.generated.bibi_api_gen.NeuronSelector

Selection of exactly one neuron using an index of a base population

property index

The index of the selected neuron within its population

class List(*args, **kw)

Bases: hbp_nrp_commons.generated.bibi_api_gen.MultiNeuronSelector

Selection of a list of neurons using their indices

property element

The indices of selected neurons

class MultiNeuronSelector(*args, **kw)

Bases: hbp_nrp_commons.generated.bibi_api_gen.NeuronSelector

The abstract base class of selections of multiple neurons

class NeuronSelector(*args, **kw)

Bases: pyxb.binding.basis.complexTypeDefinition

The abstract base class of neuron selectors

property population

The population this neuron selector refers to

class Population(*args, **kw)

Bases: hbp_nrp_commons.generated.bibi_api_gen.MultiNeuronSelector

Selection of an entire population of neurons

property count

The size of the selected population. This is necessary for validation purposes where the neural network is not available.

class PythonFilename(*args, **kw)

Bases: pyxb.binding.datatypes.string

This type denotes a path to a Python file.

class PythonTransferFunction(*args, **kw)

Bases: hbp_nrp_commons.generated.bibi_api_gen.TransferFunction

This type denotes a transfer function entirely specified in the Python DSL PyTF.

property priority

The ‘priority’ attribute is used to specify the order in which transfer functions are executed at every simulation step. Transfer functions with higher priority are executed first.

property src

The ‘src’ attribute denotes the path of a python file that contains the entire transfer function. If this attribute is present, the actual contents of the transfer function element is ignored and only the contents of the specified Python file are taken into account.

class Range(*args, **kw)

Bases: hbp_nrp_commons.generated.bibi_api_gen.MultiNeuronSelector

Selection of a range of neurons from an existing population

property from_

The starting index from which neurons are selected

property step

The step of the selection

property to

The stop index to which neurons are selected

class SDFFilename(*args, **kw)

Bases: pyxb.binding.datatypes.string

This type denotes a path to an SDF (or Zip) file

class SDFWithPath(*args, **kw)

Bases: pyxb.binding.basis.complexTypeDefinition

Complex type {http://schemas.humanbrainproject.eu/SP10/2014/BIBI}SDFWithPath with content type SIMPLE

property isCustom

Whether the model is custom

property model

If the model is custom, it tells the name of the model

property robotId

Robot id the pose refers to

class ScriptFilename(*args, **kw)

Bases: pyxb.binding.datatypes.string

This type denotes a path to a script file.

class SimulationMode(*args, **kw)

Bases: pyxb.binding.datatypes.string, pyxb.binding.basis.enumeration_mixin

The supported simulation modes of the NRP

SynchronousDirectNestSimulation = 'SynchronousDirectNestSimulation'

SynchronousNengoLoihiSimulation = 'SynchronousNengoLoihiSimulation'

SynchronousNengoSimulation = 'SynchronousNengoSimulation'

SynchronousNestSimulation = 'SynchronousNestSimulation'

SynchronousRobotRosNest = 'SynchronousRobotRosNest'

SynchronousSpinnakerSimulation = 'SynchronousSpinnakerSimulation'

class TimeStep(*args, **kw)

Bases: pyxb.binding.datatypes.positiveInteger

The timestep type of the CLE. This is a positive number in milliseconds. The maximum allowed value is an hour.

class TransferFunction(*args, **kw)

Bases: pyxb.binding.basis.complexTypeDefinition

This is the abstract type for a transfer function specification. A transfer function may be specified either in XML or in Python. These specification options are reflected in subclasses of the abstract transfer function type.

property active

Whether the Transfer Function is active