pygrenade_vx.network.Compartment

class pygrenade_vx.network.Compartment

Bases: pybind11_builtins.pybind11_object

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: _pygrenade_vx_network.Compartment, arg0: _pygrenade_vx_network.Compartment) -> None

2. __init__(self: _pygrenade_vx_network.Compartment) -> None

Methods

__init__(*args, **kwargs)	Overloaded function.
add(self, mechanism)
copy(self)
get(self, descriptor)
get_hardware(self, compartment, …)
move(self)
remove(self, descriptor)
set(self, descriptor, mechanism)
valid(self, parameter_space)	Check if the given paramter space is valid for the compartment.

class ParameterSpace

Bases: pybind11_builtins.pybind11_object

Mechanisms

alias of _pygrenade_vx_network.Map_grenade_vx_network_abstract_MechanismOnCompartment_grenade_vx_network_abstract_Mechanism_ParameterSpace_

class Parameterization

Bases: pybind11_builtins.pybind11_object

Mechanisms

alias of _pygrenade_vx_network.Map_grenade_vx_network_abstract_MechanismOnCompartment_grenade_vx_network_abstract_Mechanism_ParameterSpace_Parameterization_

property mechanisms

property mechanisms

valid(self: _pygrenade_vx_network.Compartment.ParameterSpace, parameterization: _pygrenade_vx_network.Compartment.ParameterSpace.Parameterization) → bool

Check if the given parameterization is valid for the parameter space. This checks if the parameterization is valid for each mechanism.

add(self: _pygrenade_vx_network.Compartment, mechanism: _pygrenade_vx_network.Mechanism) → _pygrenade_vx_network.MechanismOnCompartment

copy(self: _pygrenade_vx_network.Compartment) → _pygrenade_vx_network.Compartment

get(self: _pygrenade_vx_network.Compartment, descriptor: _pygrenade_vx_network.MechanismOnCompartment) → _pygrenade_vx_network.Mechanism

get_hardware(self: _pygrenade_vx_network.Compartment, compartment: grenade::vx::network::abstract::CompartmentOnNeuron, parameter_space: _pygrenade_vx_network.Compartment.ParameterSpace, environment: grenade::vx::network::abstract::Environment) → dict[_pygrenade_vx_network.MechanismOnCompartment, grenade::vx::network::abstract::HardwareResourcesWithConstraints]

move(self: _pygrenade_vx_network.Compartment) → _pygrenade_vx_network.Compartment

remove(self: _pygrenade_vx_network.Compartment, descriptor: _pygrenade_vx_network.MechanismOnCompartment) → None

set(self: _pygrenade_vx_network.Compartment, descriptor: _pygrenade_vx_network.MechanismOnCompartment, mechanism: _pygrenade_vx_network.Mechanism) → None

valid(self: _pygrenade_vx_network.Compartment, parameter_space: _pygrenade_vx_network.Compartment.ParameterSpace) → bool

Check if the given paramter space is valid for the compartment. This checks if the parameter space is valid for all mechanisms.