state module

class state.State(name, non_offender_adult_population=100)[source]

Bases: cortix.src.module.Module

State Cortix module used to model non-offender group population transit from and to a state. This assumes various ports of communication with other states, and an internal port to the internal Community.


These are the port names available in this module to connect to other State modules: inflow:id, outflow:id. In addition this module takes an internal network to model the free-offenders community of people. The port used for this connection is community. See instance attribute port_names_expected.

__init__(name, non_offender_adult_population=100)[source]
Parameters:non_offender_adult_population (float) – Individuals reaching the adult age (SI) unit. Default: 100.

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.