ExPyRe’s documentation!

A class for evaluating python functions via a queuing system, aimed at functions that take all their inputs as arguments (not files) and return all their outputs in the return values.

Evaluation can take place on the same system as the main python process that is calling the functions, or on a remote system (via passwordless ssh).

Contents:

• Basic use
• Resources
• Scheduler Configuration file
  • File format
    • Node property dict includes
    • format() keys used in header
  • Configuration file location and project scope
  • Default header lines
    • Slurm
    • Sun Grid Engine
    • PBS
  • config.json example
• Restarting an interrupted process
• Environment Variables
  • At expyre runtime
  • Available in submitted job scripts
  • Only for pytest
• Command line utilities
• Unit testing
• expyre package
  • Subpackages
    • expyre.cli package
    • expyre.schedulers package
  • Submodules
  • expyre.config module
    • Global variables
    • init()
    • update_dict_leaves()
  • expyre.func module
    • ExPyRe
    • ExPyReJobDiedError
    • ExPyReTimeoutError
  • expyre.jobsdb module
    • JobsDB
  • expyre.resources module
    • Resources
  • expyre.subprocess module
    • FailedSubprocessWarning
    • subprocess_copy()
    • subprocess_run()
  • expyre.system module
    • System
  • expyre.units module
    • mem_to_kB()
    • time_to_HMS()
    • time_to_sec()
  • expyre.util module
    • remsh_cmd()
  • Module contents

• Index

• Module Index

• Search Page