2. Getting started

Get started with the REANA reusable analysis platform by exploring the following three steps.

2.1. Step One: Structure your analysis

Structure your research data analysis repository into input “data” and “parameters”, runtime “code”, computing “environments”, and computational “workflows”, following the model of the Four questions. Create reana.yaml describing your structure:

version: 0.4.0
inputs:
  files:
    - code/mycode.py
    - data/mydata.csv
  parameters:
    myparameter: myvalue
workflow:
  type: cwl
  file: workflow/myworkflow.cwl
outputs:
  files:
    - results/myplot.png

See and run some Examples.

2.2. Step Two: Install REANA cluster

You can use an existing REANA cloud deployment (if you have access to one) by setting the REANA_SERVER_URL environment variable and providing a valid token:

$ export REANA_SERVER_URL=https://reana.cern.ch/
$ export REANA_ACCESS_TOKEN=XXXXXXX

You can also easily deploy your own REANA cloud instance by using the reana-cluster command line utility (see prerequisites):

$ # install kubectl 1.11.2 and minikube 0.28.2
$ sudo dpkg -i kubectl*.deb minikube*.deb
$ minikube start --kubernetes-version="v1.11.2"
$ # create new virtual environment
$ virtualenv ~/.virtualenvs/myreana
$ source ~/.virtualenvs/myreana/bin/activate
$ # install reana-cluster utility
$ pip install reana-cluster
$ # deploy new cluster and check progress
$ reana-cluster init
$ reana-cluster status
$ # set environment variables for reana-client
$ eval $(reana-cluster env --incude-admin-token) # since you are admin

See REANA-Cluster’s Getting started guide for more information.

2.3. Step Three: Run REANA client

You can run your analysis on the REANA cloud by using the reana-client command line client:

$ # create new virtual environment
$ virtualenv ~/.virtualenvs/myreana
$ source ~/.virtualenvs/myreana/bin/activate
$ # install REANA client
$ pip install reana-client
$ # create new workflow
$ reana-client create -n my-analysis
$ export REANA_WORKON=my-analysis
$ # upload input code and data to the workspace
$ reana-client upload
$ # start computational workflow
$ reana-client start
$ # check its progress
$ reana-client status
$ # list workspace files
$ reana-client list
$ # download output results
$ reana-client download

See REANA-Client’s Getting started guide for more information.

2.4. Next steps

For more information, please see:

  • Are you a researcher who would like to run a reusable analysis on REANA cloud? You can install and use reana-client utility that provides interface to both local and remote REANA cloud installations. For more information, please see the User guide. You may also be interested in checking out some existing Examples.
  • Are you an administrator who would like to deploy and manage REANA cloud? You can start by deploying REANA locally on your laptop using reana-cluster utility that uses Kubernetes and Minikube. For more information, please see the Administrator guide.
  • Are you a software developer who would like to contribute to REANA? You may be interested in trying out REANA both from the user point of view and the administrator point of view first. Follow by reading the Developer guide afterwards.