Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update REANA 0.3.0 getting started #23

Merged
merged 1 commit into from
Sep 28, 2018

Conversation

diegodelemos
Copy link
Member

@diegodelemos diegodelemos added this to the v0.3.0 milestone Sep 27, 2018
@diegodelemos
Copy link
Member Author

I've changed the layout for the get started section since the structure of the analysis AKA reana.yaml lines are longer and readability is a bit weird see:

screen shot 2018-09-27 at 09 39 31

This is rearranged:

screen shot 2018-09-27 at 09 37 54

@diegodelemos
Copy link
Member Author

@tiborsimko, updated with original version and keeping CWL example instead of adding Serial.

<div class="line comment"># upload runtime code and inputs</div>
<div class="line"><span class="prompt">$</span>reana-client code upload ./code/*</div>
<div class="line"><span class="prompt">$</span>reana-client inputs upload ./inputs/*</div>
<div class="line"><span class="prompt">$</span>export REANA_WORKON=$(reana-client create)</div>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the workflow creation, what about using:

$ reana-client create -n my-analysis
$ export REANA_WORKON=my-analysis

May be more readable, see reanahub/reana#87

Let's harmonise amongst the two PRs...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am on it!

@diegodelemos
Copy link
Member Author

Updated

<div class="line">inputs:</div>
<div class="line tab">files:</div>
<div class="line tab">- code/mycode.py</div>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about additional indentation for items under files: (here and below) so that it would resemble parameters:

<div class="line"><span class="prompt">$</span>reana-client create -n my-analysis</div>
<div class="line"><span class="prompt">$</span>export REANA_WORKON=my-analysis</div>
<div class="line comment"># upload input code and data to the workspace</div>
<div class="line"><span class="prompt">$</span>reana-client upload ./code ./data</div>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(1) Remove explicit ./code and ./data in the command to have harmony with the download command (=choosing implicit way), or (2) add results/plot.png to download command (=choosing explicit way).

@tiborsimko tiborsimko merged commit ad62b90 into reanahub:master Sep 28, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants