Skip to content

Commit

Permalink
Merge 2475067 into d92f47a
Browse files Browse the repository at this point in the history
  • Loading branch information
Diego committed Aug 9, 2018
2 parents d92f47a + 2475067 commit 503cc98
Show file tree
Hide file tree
Showing 9 changed files with 53 additions and 31 deletions.
6 changes: 5 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,11 @@ cache:
- pip

python:
- "3.5"
- "2.7"
- "3.6"

matrix:
fast_finish: true

before_install:
- travis_retry pip install --upgrade pip setuptools py
Expand Down
6 changes: 6 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Changes
=======

Version 0.3.0 (2018-08-10)
--------------------------

- Introduces the ``reana`` command line tool for developers.


Version 0.2.0 (2018-04-23)
--------------------------

Expand Down
Binary file modified docs/_static/setting-the-breakpoint.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/wdb-active-sessions.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/wdb-debugging-ui.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 10 additions & 9 deletions docs/developerguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ working on in development mode and we restart the corresponding pod:
$ kubectl delete pod --selector=app="server"
Let us now introduce `wdb` breakpoint as the first instruction of the
first instruction of the `get_analyses()` function located in
`reana_server/rest/analyses.py`:
first instruction of the `get_workflows()` function located in
`reana_server/rest/workflows.py`:

.. image:: /_static/setting-the-breakpoint.png

Expand All @@ -49,16 +49,17 @@ component:
$ kubectl logs --selector=app="server"
DB Created.
* Serving Flask app "/code/reana_server/app.py" (lazy loading)
* Environment: production
WARNING: Do not use the development server in a production environment.
Use a production WSGI server instead.
* Debug mode: on
* Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)
* Restarting with stat
* Debugger is active!
* Debugger PIN: 310-304-952
172.17.0.1 - - [15/Feb/2018 12:43:49] "GET /api/ping HTTP/1.1" 200 -
* Detected change in '/code/reana_server/rest/analyses.py', reloading
* Restarting with stat
* Debugger is active!
* Debugger PIN: 310-304-952
$ curl "192.168.99.100:30659/api/analyses?organization=default&user=00000000-0000-0000-0000-000000000000"
* Debugger PIN: 221-564-335
$ curl $REANA_SERVER_URL/api/workflows?access_token=$REANA_ACCESS_TOKEN
After doing that we can go to the `wdb` dashboard (you can get ``wdb`` address
using `reana-cluster get wdb <http://reana-cluster.readthedocs.io/en/latest/cliapi.html#reana-cluster-get>`_).
Expand Down
25 changes: 14 additions & 11 deletions docs/gettingstarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Structure your research data analysis repository into "inputs", "code",

.. code-block:: yaml
version: 0.2.0
version: 0.3.0
code:
files:
- code/mycode.py
Expand All @@ -40,11 +40,13 @@ 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:
setting the ``REANA_SERVER_URL`` environment variable and providing a valid
token:

.. code-block:: console
$ export REANA_SERVER_URL=https://reana.cern.ch/
$ export REANA_ACCESS_TOKEN=<ACCESS_TOKEN>
You can also easily deploy your own REANA cloud instance by using the
``reana-cluster`` command line utility:
Expand All @@ -61,7 +63,7 @@ You can also easily deploy your own REANA cloud instance by using the
$ reana-cluster init
$ reana-cluster status
$ # set environment variables for reana-client
$ eval $(reana-cluster env)
$ eval $(reana-cluster env --all)
(see `REANA-Cluster's Getting started guide
<http://reana-cluster.readthedocs.io/en/latest/gettingstarted.html>`_)
Expand All @@ -75,20 +77,21 @@ command line client:
.. code-block:: console
$ # install reana-client
$ mkvirtualenv reana-client -p /usr/bin/python2.7
$ mkvirtualenv reana-client
$ pip install reana-client
$ reana-client ping
$ # create new workflow
$ export REANA_WORKON=$(reana-client workflow create)
$ export REANA_WORKON=$(reana-client create)
$ # upload runtime code and inputs
$ reana-client code upload ./code/*
$ reana-client inputs upload ./inputs/*
$ reana-client upload ./code/*
$ reana-client upload ./inputs/*
$ # start workflow and check progress
$ reana-client workflow start
$ reana-client workflow status
$ reana-client start
$ reana-client status
$ # list files
$ reana-client list
$ # download outputs
$ reana-client outputs list
$ reana-client outputs download myplot.png
$ reana-client download myplot.png
(see `REANA-Client's Getting started guide
<http://reana-client.readthedocs.io/en/latest/gettingstarted.html>`_)
Expand Down
26 changes: 17 additions & 9 deletions docs/userguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The ``reana.yaml`` describing this structure look as follows:

.. code-block:: yaml
version: 0.2.0
version: 0.3.0
code:
files:
- code/mycode.py
Expand Down Expand Up @@ -101,7 +101,7 @@ using ``pip``, for example:
.. code-block:: console
$ # install reana-client
$ mkvirtualenv reana-client -p /usr/bin/python2.7
$ mkvirtualenv reana-client
$ pip install reana-client
You can run ``reana-client --help`` to obtain help.
Expand All @@ -116,6 +116,13 @@ There are several convenient environment variables you can set when working with
$ export REANA_SERVER_URL=http://reana.cern.ch
- ``REANA_ACCESS_TOKEN`` Identifies the current user when performing
protected actions.

.. code-block:: console
$ export REANA_ACCESS_TOKEN=<ACCESS-TOKEN>
- ``REANA_WORKON`` Permits to specify a concrete workflow run for the given
analysis. (As an alternative to specifying ``--workflow`` name in commands.)
For example:
Expand All @@ -129,16 +136,17 @@ The typical usage scenario of ``reana-client`` goes as follows:
.. code-block:: console
$ # create new workflow
$ export REANA_WORKON=$(reana-client workflow create)
$ export REANA_WORKON=$(reana-client create)
$ # upload runtime code and inputs
$ reana-client code upload ./code/*
$ reana-client inputs upload ./inputs/*
$ reana-client upload ./code/*
$ reana-client upload ./inputs/*
$ # start workflow and check progress
$ reana-client workflow start
$ reana-client workflow status
$ reana-client start
$ reana-client status
$ # list files
$ reana-client list
$ # download outputs
$ reana-client outputs list
$ reana-client outputs download myplot.png
$ reana-client download myplot.png
For more information, please see `REANA-Client's Getting started guide
<http://reana-client.readthedocs.io/en/latest/gettingstarted.html>`_.
Expand Down
2 changes: 1 addition & 1 deletion reana/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@

from __future__ import absolute_import, print_function

__version__ = "0.3.0.dev20180503"
__version__ = "0.3.0"

0 comments on commit 503cc98

Please sign in to comment.