Simbrain API

There are two main packages in Simbrain: the Simbrain package, which contains all the code for the GUI and its components, and the simnet package which contains the code for the simbrain neural networks.

See:
Description

Packages

org.simbrain.gauge	The simbrain.gauge package contains code for creating and managing gauges, which project from arbitrary dimensional spaces to two dimensions.
org.simbrain.gauge.core	The simbrain.gauge.core package contains the logical code for gauges.
org.simbrain.gauge.graphics	The simbrain.gauge.graphics package contains the code which graphically represents gauges.
org.simbrain.network	The simbrain.network package contains the Piccolo-based zoomable GUI for designing, editing, and running neural networks.
org.simbrain.network.actions	The simbrain.network.action package contains the actions for responding to network events.
org.simbrain.network.dialog	The simbrain.network.dialog package contains all the dialog classes for graphical networks.
org.simbrain.network.dialog.network	The simbrain.network.dialog.network package contains dialog classes that manage the creation and editing of network-level dialog boxes.
org.simbrain.network.dialog.network.layout	The simbrain.network.dialog.network.layout package contains the different neuron layouts for creating networks.
org.simbrain.network.dialog.neuron	The simbrain.network.dialog.neuron package contains dialog classes that manage the creation and editing of neuron-level dialog boxes.
org.simbrain.network.dialog.synapse	The simbrain.network.dialog.synapse package contains dialog classes that manage the creation and editing of synapse-level dialog boxes.
org.simbrain.network.filters	The simbrain.network.filters package contains node filters.
org.simbrain.network.nodes	The simbrain.network.nodes package contains Piccolo nodes for various network elements.
org.simbrain.network.nodes.subnetworks	The simbrain.network.nodes.subnetworks package contains the different network types.
org.simbrain.resource	The simbrain.resource package contains all the images used in Simbrain, as well as a class which provides access to to those images.
org.simbrain.util	The simbrain.util package contains utilities classes used by multiple Simbrain packages.
org.simbrain.workspace	The simbrain.workspace package contains the top level container for the other components of Simbrain--the network, world, and gauge(s).
org.simbrain.world	The simbrain.world package contains as sub-packages all code for "worlds." Worlds are simbrain components which interact with neural networks by producing inputs and accepting outputs.
org.simbrain.world.dataworld	The simbrain.world.dataworld package contains the simplest world type, a "dataworld" which is simply a spreadsheet which sends data to worlds in the form of rows on a simple table.
org.simbrain.world.odorworld	The simbrain.world.odorworld package describes a world in which an agent can move around and smell objects, which are coded as vectors of values which diminish in various ways as the agent is closer or farther from the agent.
org.simbrain.world.textworld	The simbrain.world.textworld package describes a world in which strings of text are converted into vectors.
org.simbrain.world.visionworld	The simbrain.world.visionworld package describes a very simple retina, in which a matrix of pixels are either on or off, and thereby send one of two values (e.g.
org.simnet	The simnet package contains the logical representation of neural networks.
org.simnet.coupling	The simbrain.coupling package contains objects representing relations between an agent and an input or output node.
org.simnet.interfaces	The simnet.interfaces package contains all high level neural network classes, i.e.
org.simnet.layouts	The simnet.layouts package contains the neuron layouts.
org.simnet.networks	The simnet.networks package contains all neural network types in Simbrain.
org.simnet.neurons	The simnet.neurons package contains code which describes all particular neuron types in Simbrain.
org.simnet.synapses	The simnet.synapses package contains code which describes all particular synpase or weight types in Simbrain.
org.simnet.synapses.spikeresponders	The spikeresponders package contains methods by which spikes are converted into activation post-synaptically.
org.simnet.util	The simnet.util package contains utility classes for simnet.

There are two main packages in Simbrain: the Simbrain package, which contains all the code for the GUI and its components, and the simnet package which contains the code for the simbrain neural networks. The Simbrain package contains the GUI representation of neural networks, gauges, worlds, couplings, and the workspace. Neural networks, gauges, and worlds are thre three visible components in Simbrain: neural nets are simulated brain circuits, worlds simulate methods of producing inputs to and accepting outputs from neural networks, and gauges represent the states that have occurred in a neural network (either neuron and weight states). Couplings control interactions between neural networks and worlds. Worlds are components which produce inputs to neural networks and accept outputs. The workspace is the GUI space which contains all particular components.