API Reference (Blender Add-On)

utils

utils

utilities to make interacting with blender objects more straightforward

• see API Reference (Blender Utils) for details

geo_nodes

geo_nodes	custom geometry nodes node groups
geo_nodes.network_container()	creates a geometry nodes node group to style the network container
geo_nodes.neurite_bends()	applies random bends to some curve
geo_nodes.neurite_branches()	creates a set of branches in random directions originating at Host Mesh
geo_nodes.neurite_to_mesh()	converts some input neurite (curve) to a mesh
geo_nodes.neurite_twist()	applies twist to some curve
geo_nodes.neuron_neurites()	creates template geonodes node group for defining neurons, dendrites, and axons
geo_nodes.position_global()	creates a geometry nodes node group that returns position in global (world) coordinates
geo_nodes.remesh()	creates a geometry nodes node group similar to remesh modifier
geo_nodes.scale_radial()	creates a geometry nodes node group that scales input geometry radially
geo_nodes.spiketrain()	creates a geometry nodes node group to generate colors for spiketrain

network

network

base class and function to create a SNNIB network

network	base class and function to create a SNNIB network
network.Network(…)	container representing a spiking neural network
network.Network.__init__(…)	constructor
network.Network._get_mean_outconnection(…)	returns vector describing the direction of mean outgoing connection from neuron pre_idx
network.Network.generate_network()	generates random network based on user input
network.Network.read_network()	reads a network from self.network_file
network.Network.setup_container()	sets up the network container
network.Network.draw_neurons()	draws neurons into the scene
network.Network.draw_synapses()	draws synapses into the scene

network.generate_template_neuron(…)

returns generated template neuron object

operators

operators	operators used within the [blender](https://www.blender.org/) UI
operators.SNNIB_OT_build_snn(…)	operator to build a SNN with the current user settings
operators.SNNIB_OT_build_snn.execute(…)	builds the SNNIB network
operators.SNNIB_OT_make_template_neuron(…)	operator to create a template neuron
operators.SNNIB_OT_make_template_neuron.execute(…)	creates template neuron
operators.SNNIB_OT_init_geo_nodes(…)	initializes all geometry nodes node trees needed for the add-on to work
operators.SNNIB_OT_init_geo_nodes.execute(…)	creates geo nodes node trees needed for SNNIB
operators.SNNIB_OT_init_shader_nodes(…)	initializes all shader nodes node trees needed for the add-on to work
operators.SNNIB_OT_init_shader_nodes.execute(…)	creates shader nodes node trees needed for SNNIB

panels

panels	defines the [blender](https://www.blender.org/) UI panels
panels.SNNIB_PT_Panel(…)	panel hosting the add-on

properties

properties	defines custom properties used by SNNIB
properties.SnnibProperties(…)	custom properties used in SNNIB

shader nodes

shader_nodes	custom shader node node groups
shader_nodes.spiking_neuron()	creates base material for spiking neuron

spiketrain

spiketrain

functions related to spiketrain generation and manipulation