Writing User Functions

User functions typically require only some familiarity with NumPy, but if they conform to the user function APIs, they can incorporate methods from machine-learning, mathematics, resource management, or other libraries/applications.

These guides describe common development patterns and optional components:

Writing User Functions

• Generator Functions
  • Writing a Generator
  • Persistent Generators
  • Active receive mode
  • Cancelling Simulations
  • Modification of existing points
  • Generator initiated shutdown
  • Examples
• Simulator Functions
  • Writing a Simulator
  • Executor
  • Persistent Simulators
• Allocation Functions
  • AllocSupport
• User Function API
  • sim_f API
  • gen_f API
  • alloc_f API

Useful Data Structures

• calc_status
• Work Dictionary
• Worker Array