14. Developer Documentation

14.1. Installation from Source

If you are planning to contribute to the RADICAL-Pilot codebase, or if you want to use the latest and greatest development features, you can download and install RADICAL-Pilot directly from the sources.

First, you need to check out the sources from GitHub.

git clone git@github.com:radical-cybertools/radical.pilot.git

Next, run the installer directly from the source directoy (assuming you have set up a vritualenv):

pip install --upgrade .

14.2. License

RADICAL-Pilot uses the MIT License (https://github.com/radical-cybertools/radical.pilot/blob/devel/LICENSE.md).

14.3. Style Guide

To maintain consistency and uniformity we request people to try to follow our coding style guide lines.

We generally follow PEP 8 (http://legacy.python.org/dev/peps/pep-0008/), with currently one explicit exception:

  • When alignment of assignments improves readability.

14.4. Debugging

The RADICAL_PILOT_VERBOSE environment variable controls the debug output of a RADICAL-Pilot application. Possible values are:

  • debug
  • info
  • warning
  • error

The environment variable RADICAL_PILOT_AGENT_VERBOSE controls the debug log level of the agent process on the target resource. If it is not set, the log level from RADICAL_PILOT_VERBOSE is used.

14.5. RADICAL-Pilot Architecture

Describe architecture overview here.

14.5.1. PilotManager and PilotManager Worker

_images/architecture_pilotmanager.png

Download PDF version.

14.5.2. UnitManager and UnitManager Worker

_images/architecture_unitmanager.png

Download PDF version.