3. User guide

3.1. Environment variables

3.1.1. REANA_SERVER_URL

You can set this environment variable in order to specify to which REANA cloud instance your client should connect. For example:

$ export REANA_SERVER_URL=http://reana.cern.ch

3.1.2. REANA_WORKON

You can set this environment variable in order to specify a concrete workflow you would like to work on. (As an alternative to specifying --workflow option in commands.) For example:

$ export REANA_WORKON=myfirstanalysis

will work on the latest run of your “myfirstanalysis” workflow.

Note that you can also specify a concrete run number:

$ export REANA_WORKON=myfirstanalysis.3

which will permit to work on the third run of the “myfirstanalysis” workflow, for example to check out past input and output files.

You can list all your workflow runs and their statuses by doing:

$ reana-client workflow list

and set REANA_WORKON to the one you would like to work on.

3.2. Usage

Please see the Getting Started section for a basic reana-client use case scenario.

3.3. Status

You can use the reana-client status command to see the current status of your REANA client session. The command prints an information to which REANA cloud is the client connected, what is the current workflow the client is working on, and what is the workflow status:

$ reana-client status
User: 00000000-0000-0000-0000-000000000000
REANA cluster selected: http://192.168.39.238:30380
REANA cluster status: ready
Workflow selected: workflow.2
Workflow status: finished

3.4. Examples

You can get inspiration on how to structure your REANA-compatible research data analysis from several reana-demo-... examples provided on GitHub:

3.5. Commands

The full list of reana-client commands with their documented options is available in the CLI API documentation.