probation module

class probation.Probation(n_groups=1, pool_size=0.0)[source]

Bases: cortix.src.module.Module

Probation Cortix module used to model criminal group population in a probation.


These are the port names available in this module to connect to respective modules: adjudication, jail, arrested, and community. See instance attribute port_names_expected.

__init__(n_groups=1, pool_size=0.0)[source]
  • n_groups (int) – Number of groups in the population.
  • pool_size (float) – Upperbound on the range of the existing population groups. A random value from 0 to the upperbound value will be assigned to each group.

Module run function

Run method with an option to pass data back to the parent process when running in Python multiprocessing mode. If the user does not want to share data with the parent process, this function can be overriden with run(self) or run(self, *args) as long as self.state = None. If self.state points to anything but None, the user must use `run(self, *args).


When in multiprocessing, *args has two elements: comm_idx and comm_state. To pass back the state of the module, the user should insert the provided index comm_idx and the state into the queue as follows:

if self.use_multiprocessing:
except pickle.PicklingError:

at the bottom of the user defined run() function.


This function must be overridden by all Cortix modules

  • arg[0] (int) – Index of the state in the communication queue.
  • arg[1] (multiprocessing.Queue) – When using the Python multiprocessing library state_comm must have the module’s self.state in it. That is, state_comm.put((idx_comm,self.state)) must be the last command in the method before return. In addition, self.state must be pickle-able.