Needed Modules ============== .. Do not edit this section It was auto-generated .. by the `update_README.py` script. .. image:: tree_dependency.png * `Perturbation `_ * `Selectors_full `_ * `Generators_full `_ * `ZMQ `_ Documentation ============= .. Do not edit this section It was auto-generated .. by the `update_README.py` script. `add_comb `_ Undocumented `add_task_to_taskserver `_ Get a task from the task server `add_task_to_taskserver_recv `_ Get a task from the task server `add_task_to_taskserver_send `_ Get a task from the task server `add_to_selection_buffer `_ Undocumented `assert `_ Undocumented `bitstring_to_list_in_selection `_ Gives the inidices(+1) of the bits set to 1 in the bit string `comb_step `_ Undocumented `comb_teeth `_ Undocumented `connect_to_taskserver `_ Connect to the task server and obtain the worker ID `create_selection_buffer `_ Undocumented `delete_selection_buffer `_ Undocumented `disconnect_from_taskserver `_ Disconnect from the task server `do_carlo `_ Undocumented `end_parallel_job `_ End a new parallel job with name 'name'. The slave tasks execute subroutine 'slave' `end_zmq_pair_socket `_ Terminate socket on which the results are sent. `end_zmq_pull_socket `_ Terminate socket on which the results are sent. `end_zmq_push_socket `_ Terminate socket on which the results are sent. `end_zmq_sub_socket `_ Terminate socket on which the results are sent. `end_zmq_to_qp_run_socket `_ Terminate the socket from the application to qp_run `fci_zmq `_ Undocumented `fill_buffer_double `_ Undocumented `first_det_of_comb `_ Undocumented `first_det_of_teeth `_ Undocumented `fragment_count `_ Number of fragments for the deterministic part `fragment_first `_ Undocumented `get_carlo_workbatch `_ Undocumented `get_comb `_ Undocumented `get_d0 `_ Undocumented `get_d1 `_ Undocumented `get_d2 `_ Undocumented `get_first_tooth `_ Undocumented `get_m0 `_ Undocumented `get_m1 `_ Undocumented `get_m2 `_ Undocumented `get_mask_phase `_ Undocumented `get_phase_bi `_ Undocumented `get_task_from_taskserver `_ Get a task from the task server `initialize_pt2_e0_denominator `_ If true, initialize pt2_E0_denominator `integral8 `_ Undocumented `merge_selection_buffers `_ Merges the selection buffers b1 and b2 into b2 `new_parallel_job `_ Start a new parallel job with name 'name'. The slave tasks execute subroutine 'slave' `new_zmq_pair_socket `_ Socket on which the collector and the main communicate `new_zmq_pull_socket `_ Socket on which the results are sent. If thread is 1, use inproc `new_zmq_push_socket `_ Socket on which the results are sent. If thread is 1, use inproc `new_zmq_sub_socket `_ Socket to read the state published by the Task server `new_zmq_to_qp_run_socket `_ Socket on which the qp_run process replies `past_d1 `_ Undocumented `past_d2 `_ Undocumented `provide_everything `_ Undocumented `pt2_collector `_ Undocumented `pt2_cweight `_ Undocumented `pt2_cweight_cache `_ Undocumented `pt2_e0_denominator `_ E0 in the denominator of the PT2 `pt2_find `_ Undocumented `pt2_slave `_ Helper program to compute the PT2 in distributed mode. `pt2_slave_inproc `_ Undocumented `pt2_slave_tcp `_ Undocumented `pt2_stoch `_ Undocumented `pt2_weight `_ Undocumented `pt2_weight_inv `_ Inverse of pt2_weight array `pt2_workload `_ Undocumented `pull_pt2_results `_ Undocumented `pull_selection_results `_ Undocumented `push_pt2_results `_ Undocumented `push_selection_results `_ Undocumented `qp_run_address `_ Address of the qp_run socket Example : tcp://130.120.229.139:12345 `reset_zmq_addresses `_ Socket which pulls the results (2) `run_pt2_slave `_ Undocumented `run_selection_slave `_ Undocumented `run_wf `_ Undocumented `select_connected `_ Undocumented `select_singles_and_doubles `_ WARNING /!\ : It is assumed that the generators and selectors are psi_det_sorted `selection_collector `_ Undocumented `selection_slave `_ Helper program to compute the PT2 in distributed mode. `selection_slave_inproc `_ Undocumented `size_tbc `_ Size of the tbc array `sort_selection_buffer `_ Undocumented `splash_pq `_ Undocumented `spot_isinwf `_ Undocumented `switch_qp_run_to_master `_ Address of the master qp_run socket Example : tcp://130.120.229.139:12345 `task_done_to_taskserver `_ Get a task from the task server `wait_for_next_state `_ Undocumented `wait_for_state `_ Wait for the ZMQ state to be ready `wait_for_states `_ Wait for the ZMQ state to be ready `zmq_abort `_ Aborts a running parallel computation `zmq_context `_ Context for the ZeroMQ library `zmq_delete_task `_ When a task is done, it has to be removed from the list of tasks on the qp_run queue. This guarantees that the results have been received in the pull. `zmq_lock `_ Context for the ZeroMQ library `zmq_port `_ Return the value of the ZMQ port from the corresponding integer `zmq_port_start `_ Address of the qp_run socket Example : tcp://130.120.229.139:12345 `zmq_pt2 `_ Undocumented `zmq_selection `_ Undocumented `zmq_set_running `_ Set the job to Running in QP-run `zmq_socket_pair_inproc_address `_ Socket which pulls the results (2) `zmq_socket_pull_inproc_address `_ Socket which pulls the results (2) `zmq_socket_pull_tcp_address `_ Socket which pulls the results (2) `zmq_socket_push_inproc_address `_ Socket which pulls the results (2) `zmq_socket_push_tcp_address `_ Socket which pulls the results (2) `zmq_socket_sub_tcp_address `_ Socket which pulls the results (2) `zmq_state `_ Threads executing work through the ZeroMQ interface