SimCX Reference

Core

A simulation framework for complex systems modelling and analysis.

class simcx.Display(width=500, height=500, interval=0.05, multi_sampling=True, **kwargs)

Bases: object

add_simulator(sim: simcx.Simulator)

add_visual(visual: simcx.Visual, x=0, y=0)

on_close()

on_draw()

on_key_press(symbol, modifiers)

start_recording(filename='simcx.mp4', fps=None, bitrate=1800)

class simcx.FFMpegWriter(fps=5, codec=None, bitrate=None, extra_args=None, metadata=None)

Bases: matplotlib.animation.FFMpegWriter

frame_size

A tuple (width,height) in pixels of a movie frame.

grab_frame(**savefig_kwargs)

Grab the image information from the display and save as a movie frame. The keyword arguments are not being used in the subclass.

setup(display, outfile)

Perform setup for writing the movie file. display: simcx.Display instance The Display instance whose framebuffer we want to use. outfile: string The filename of the resulting movie file

class simcx.MplVisual(sim: simcx.Simulator, **kwargs)

Bases: simcx.Visual

update_image()

class simcx.PyafaiSimulator(world)

Bases: simcx.Simulator

step(delta=0)

class simcx.PyafaiVisual(sim: simcx.PyafaiSimulator, width=500, height=500)

Bases: simcx.Visual

draw()

class simcx.Simulator

Bases: object

reset()

step(delta=0)

class simcx.Visual(sim: simcx.Simulator, **kwargs)

Bases: object

draw()

simcx.run()

Submodules

simcx.simulators module

This module provides several ready-made simulator classes. Used mainly for the examples given in the Complex Systems course. In this current version, these should not be considered stable in terms of API.

class simcx.simulators.FinalStateIterator(func, seed, start, end, discard=1000, samples=250, delta=0.01)

Bases: simcx.Simulator

step(delta=0)

class simcx.simulators.FunctionIterator(func, initial_states)

Bases: simcx.Simulator

reset()

step(delta=0)

class simcx.simulators.FunctionIterator2D(func, initial_state)

Bases: simcx.Simulator

step(delta=0)

class simcx.simulators.IFS(transforms, probs, step_size=100)

Bases: simcx.Simulator

An Iterated Function Systems simulator using the Chaos Game.

step(delta=0, discard=False)

class simcx.simulators.JuliaSet(c, min_x=-2, max_x=2, min_y=-2, max_y=2, samples=500, iterations=100)

Bases: simcx.Simulator

A simulator to calculate the Julia Set of a function in the form . The simulator will compute the Julia Set for the given range (min_x, min_y) to (max_x, max_y) on creation of the instance.

Note: numexpr optimized version inspired by code by Jean-François Puget.

step(delta=0)

simcx.visuals module

This module provides several ready-made visual classes. Used mainly for the examples given in the Complex Systems course. In this current version, these should not be considered stable in terms of API.

class simcx.visuals.BifurcationDiagram(sim: simcx.simulators.FinalStateIterator, **kwargs)

Bases: simcx.MplVisual

draw()

class simcx.visuals.CobWebVisual(sim: simcx.simulators.FunctionIterator, min_x, max_x, func_string='', **kwargs)

Bases: simcx.MplVisual

draw()

class simcx.visuals.FinalStateDiagram(sim: simcx.simulators.FunctionIterator, discard_initial=1000, **kwargs)

Bases: simcx.MplVisual

draw()

class simcx.visuals.FractalVisual(sim, gamma=1.0, **kwargs)

Bases: simcx.MplVisual

class simcx.visuals.Line(sim: simcx.Simulator, x: list, y: list, auto_size=True, **kwargs)

Bases: simcx.MplVisual

draw()

class simcx.visuals.Lines(sim: simcx.Simulator, auto_size=True, **kwargs)

Bases: simcx.MplVisual

draw()

class simcx.visuals.PhaseSpace2D(sim: simcx.simulators.FunctionIterator2D, name_x, name_y, **kwargs)

Bases: simcx.visuals.Line

class simcx.visuals.Points2D(sim, min_x=0.0, max_x=1.0, min_y=0.0, max_y=1.0, **kwargs)

Bases: simcx.Visual

draw()

class simcx.visuals.TimeSeries(sim: simcx.simulators.FunctionIterator, **kwargs)

Bases: simcx.visuals.Lines