Skip to content

wrench-project/wrench-python-api

Repository files navigation

Build License: LGPL v3 coverage-badge

WRENCH Project
Cyberinfrastructure Simulation Workbench

Objective

Provide a Python API for WRENCH. This API is built on top of WRENCH's REST API.

Dependencies and Installation

  • WRENCH and its dependencies

    • You must compile the wrench-daemon target (i.e., make wrench-daemon) during the build process before doing the usual (sudo make install)
  • Run python3 -m build to build the package.

  • Run python3 -m pip install ./dist/wrench-*.whl to install the package

Examples and API Documentation

Example simulators are provided in the examples directory. See the README file therein for information on what these examples are and how to run them.

For complete documentation, see the API Documentation page.