cypress::NEST Class Reference

#include <nest.hpp>

Inheritance diagram for cypress::NEST:

Collaboration diagram for cypress::NEST:

Classes
class	NESTSimulatorNotFound

Public Member Functions
	NEST (const Json &setup=Json())
	~NEST () override=default
std::unordered_set< const NeuronType * >	supported_neuron_types () const override
std::string	name () const override
void	run (NetworkBase &network, Real duration=0.0) const

Static Public Member Functions
static bool	installed ()
static std::string	version ()

Detailed Description

The NEST backend directly runs the simulation on the NEST simulator without using PyNN. A recent version of NEST must be installed and the "nest" executable must be available in the path.

Constructor & Destructor Documentation

cypress::NEST::NEST

(

const Json &

setup = Json()

)

Constructor of the NEST backend class, takes a PyNN-like setup JSON object.

Parameters

setup

is a JSON object which supports the following settings:

{ "timestep": 0.1, // The simulation timestep "record_interval": 0.1 // Sample interval when recording "threads": 1.0 // number of threads }

cypress::NEST::~NEST ( )

overridedefault

Destructor of the NEST backend class.

Member Function Documentation

static bool cypress::NEST::installed ( )

static

Returns true if NEST is installed.

std::string cypress::NEST::name ( ) const

inlineoverridevirtual

Returns the canonical name of the backend.

Implements cypress::Backend.

void cypress::Backend::run ( NetworkBase &  network, Real  duration = 0.0  ) const

inherited

Simulates the given spiking neural network for the given duration.

Parameters

network	is the network that should be simulated. The simulation result will be written to the network instance.
duration	is the duration for which the network should be simulated.

std::unordered_set<const NeuronType *> cypress::NEST::supported_neuron_types ( ) const

overridevirtual

Returns the neuron types supported by the NEST backend.

Implements cypress::Backend.

static std::string cypress::NEST::version ( )

static

Returns the installed NEST version or an empty string if NEST is not found.

---

The documentation for this class was generated from the following file:

• cypress/backend/nest/nest.hpp