example_run function

(Shortest import: from brian2cuda.__init__ import example_run)

brian2cuda.__init__.example_run(device_name='cuda_standalone', directory=None, **build_options)[source]

Run a simple example simulation to test whether Brian2CUDA is correctly set up.


device_name : str

What device to use (default: “cuda_standalone”).

directory : str ,optional

The output directory to write the project to, any existing files will be overwritten. If the given directory name is None (default for this example run), then a temporary directory will be used.

build_options : dict, optional

Additional options that will be forwarded to the device.build call,