pygrenade_vx.network.multicompartment.compartment_builder.CompartmentBuilder

class pygrenade_vx.network.multicompartment.compartment_builder.CompartmentBuilder

Bases: object

Construct a new compartment class.

From this class compartments can be initialized which can be used to build a multi-compartmental neuron model.

__init__()

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__()	Initialize self.
add(mechanism, label)	Add the given mechansim to the compartment.
done(name)	Return a class which represents the constructed compartment.

add(mechanism: pygrenade_vx.network.multicompartment.mechanisms.Mechanism, label: str)

Add the given mechansim to the compartment.

Parameters

• mechanism – Mechanism to add.

• label – Label of the mechanism.

done(name: str)

Return a class which represents the constructed compartment.

The class is derived from the Compartment class and mechansims are saved in a class member.

Parameters

name – Name of the created compartment class.

Returns

Built compartment class.