DataSim documentation

This library provides a framework for generating data by running simulations.

datasim.Constant(world, id, value)	A numeric or string value used to initialise a simulation run.
datasim.Dataset(world, id, *args)	Base class for saving data and updating data for plots to be made on a dashboard.
datasim.DataSource(world, plot_options)	Abstract superclass of different types of data to save and/or plot.
datasim.XYData(world, data_x, data_y, ...)	Data with x and y values as float.
datasim.CategoryData(world, data_x, data_y, ...)	Data with named categories with float values.
datasim.NPData(world, data, plot_options)	Data with Numpy array as source.
datasim.ResourceData(world, source_id, ...)	Data source from watching the amount of a Resource.
datasim.QueueData(world, source_id, ...)	Data source from watching the size of a Queue.
datasim.StateData(world, source, frequency, ...)	Data source from watching the state of an Entity.
datasim.Entity(world, id, initial_state, ...)	An entity in the simulation world.
datasim.State(name, entity[, completion])	The current behavior state of an Entity.
datasim.logging
datasim.Output()	Abstract class to show and store the state and results of the simulation.
datasim.SimpleFileOutput()	Simple/fastest output without dashboard: only stores data.
datasim.Quantity(world, id, quantity_type, ...)	Representation of a custom quantity that can be automatically saved and plotted.
datasim.Queue(world, id, capacity, gather, ...)	A queue for entities to wait for resource availability.
datasim.Resource(world, id, resource_type, ...)	Representation of a resource in the simulation.
datasim.UsingResourceState(resource, entity)	State in which an Entity is using a Resource.
datasim.Runner(world_class_object[, ...])	Main simulation runner for DataSim.
datasim.LogLevel(*values)	The result of a resource usage attempt.
datasim.PlotType(*values)	The type of plot to render.
datasim.PlotOptions([title, name, ...])	Defines the options for plotting a Data.
datasim.UseResult(*values)	The result of a resource usage attempt.
datasim.World(runner[, title, tpu, ...])	Abstract base class for the simulation world.

Index

Search Page