VRE Middleware Logo

Quick start

  • Prerequisites
  • Installation and setup
  • Run the unit tests
  • Activate schema validation

Using the API

  • Manage workflows with WFEngine
  • Query workflows and workflow nodes
  • Resource configuration
  • How to create a LaunchPad object
  • How to create a qadapter object
  • Run a launcher on a remote computer

Using the GUI

  • How to manage workflows with the Ipywidgets GUI

Using the CLI

  • The wfengine command-line tool
  • The resconfig command-line tool

Help

  • Troubleshooting
  • Frequently asked questions (FAQs)

How to cite

  • Citing the VRE Middleware package

Comprehensive documentation

  • virtmat namespace
    • Packages
      • virtmat.middleware package
    • Module contents
VRE Middleware
  • virtmat namespace
  • View page source

virtmat namespace

Packages

  • virtmat.middleware package
    • Subpackages
      • virtmat.middleware.engine package
        • Submodules
        • virtmat.middleware.engine.wfengine module
        • virtmat.middleware.engine.wfengine_jupyter module
        • virtmat.middleware.engine.wfengine_remote module
        • Module contents
      • virtmat.middleware.query package
        • Submodules
        • virtmat.middleware.query.dbquery module
        • virtmat.middleware.query.wfquery module
        • Module contents
      • virtmat.middleware.resconfig package
        • Submodules
        • virtmat.middleware.resconfig.cli module
        • virtmat.middleware.resconfig.qadapter module
        • virtmat.middleware.resconfig.resconfig module
        • Module contents
    • Submodules
    • virtmat.middleware.exceptions module
      • ConfigurationException
      • CustomException
      • InvalidStateException
      • LmodError
      • ResourceConfigurationError
      • SlurmError
      • TestingException
    • virtmat.middleware.utilities module
      • await_slurm_job_state()
      • exec_cancel()
      • format_warning_wrapper()
      • get_command_output()
      • get_env_modules()
      • get_logger()
      • get_slurm_job_state()
      • get_slurm_job_state_json()
      • get_slurm_job_state_parse()
      • get_unreserved_nodes()
      • get_venv()
      • lmod_env_module()
      • module_cmd()
      • module_load()
      • module_remove()
    • Module contents

Module contents

this is a namespace and no usual python package

Previous Next

© Copyright 2023, Karlsruhe Institute of Technology.

Built with Sphinx using a theme provided by Read the Docs.