Skip to content

Commit

Permalink
Update account setup instructions (#790)
Browse files Browse the repository at this point in the history
* update account set up for py3 CWL, moved docker install to dependencies (part1), separated out CWL since optional
  • Loading branch information
Ldcabansay authored Sep 13, 2019
1 parent 8187a93 commit d4ddcca
Showing 1 changed file with 25 additions and 26 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ export class DownloadCLIClientComponent implements OnInit {
#### Requirements
1. Linux/Ubuntu (Recommended - Tested on 18.04.3 LTS) or Mac OS X machine
2. Java 11 (Tested with OpenJDK 11, Oracle JDK may work but is untested)
3. Python and pip (Optional: if working with CWL)
3. Python3 and pip3 (Optional: if working with CWL)
#### Part 1 - Install dependencies and Dockstore CLI
1. Install Java 11 (This example installs OpenJDK 11)
Expand All @@ -71,7 +71,14 @@ sudo add-apt-repository ppa:openjdk-r/ppa \
&& sudo apt-get update -q \
&& sudo apt install -y openjdk-11-jdk
\`\`\`
2. Install the dockstore command-line program and add it to the path.
2. Install Docker following the instructions on [Docker's website](https://docs.docker.com/install/linux/docker-ce/ubuntu/). You should have at least version 19.03.1 installed.
Ensure that you are able to run Docker without using sudo directly with the
[post install instructions](https://docs.docker.com/engine/installation/linux/linux-postinstall/#manage-docker-as-a-non-root-user).
\`\`\`
sudo usermod -aG docker $USER
exec newgrp docker
\`\`\`
3. Install the dockstore command-line program and add it to the path.
\`\`\`
mkdir -p ~/bin
curl -L -o ~/bin/dockstore ${this.downloadCli}
Expand All @@ -92,7 +99,21 @@ printf "token: ${this.dsToken}\\nserver-url: ${this.dsServerURI}\\n" > ~/.dockst
2. Alternatively, copy this content to your config file directly.
`;
this.textData3 = `
#### Part 3 - Install cwltool (Optional)
#### Part 3 - Confirm installation
1. Run our dependencies to verify that they have been installed properly.
\`\`\`
$ java -version
openjdk version "11.0.4" 2019-07-16
$ dockstore --version
Dockstore version ${this.dockstoreVersion}
OpenJDK Runtime Environment (build 11.0.4+11-post-Ubuntu-1ubuntu218.04.3)
OpenJDK 64-Bit Server VM (build 11.0.4+11-post-Ubuntu-1ubuntu218.04.3, mixed mode, sharing)
$ docker run hello-world
Hello from Docker!
...
\`\`\`
#### Part 4 - Install cwltool (Optional)
Dockstore relies on [cwltool](https://github.com/common-workflow-language/cwltool) -a reference implementation of CWL- for local execution of tools and workflows described with CWL.
You'll need to have Python 3 and [pip3](https://pip.pypa.io/en/latest/installing/) to be installed on your machine.
Expand All @@ -101,36 +122,14 @@ You'll need to have Python 3 and [pip3](https://pip.pypa.io/en/latest/installing
You can install the version of cwltool that we've tested for use with Dockstore using the following commands:
1. Run this to verify that pip has been installed \`pip3 --version\`
2. Run these commands to install cwltool
<!-- Workaround until https://github.com/common-workflow-language/cwltool/issues/524 is resolved -->
If using Python 3, install cwl-avro instead of avro. Do this by running these commands:
\`\`\`
curl -o requirements.txt "${this.dsServerURI}/metadata/runner_dependencies?client_version=${this.dockstoreVersion}&python_version=3"
pip3 install -r requirements.txt
\`\`\`
Verify using \`pip3 list\` that the installed pip packages matches the ones specified in the downloaded requirements.txt.
3. Install Docker following the instructions on [Docker's website](https://docs.docker.com/install/linux/docker-ce/ubuntu/). You should have at least version 19.03.1 installed.
Ensure that you are able to run Docker without using sudo directly with the
[post install instructions](https://docs.docker.com/engine/installation/linux/linux-postinstall/#manage-docker-as-a-non-root-user).
\`\`\`
sudo usermod -aG docker $USER
exec newgrp docker
\`\`\`
#### Part 4 - Confirm installation
1. Run our dependencies to verify that they have been installed properly.
3. Verify using \`pip3 list\` that the installed pip packages match the ones specified in the downloaded requirements.txt. Confirm cwltool installation by checking the version.
\`\`\`
$ dockstore --version
Dockstore version ${this.dockstoreVersion}
$ java -version
openjdk version "11.0.4" 2019-07-16
OpenJDK Runtime Environment (build 11.0.4+11-post-Ubuntu-1ubuntu218.04.3)
OpenJDK 64-Bit Server VM (build 11.0.4+11-post-Ubuntu-1ubuntu218.04.3, mixed mode, sharing)
$ cwltool --version
/usr/local/bin/cwltool ${this.cwltoolVersion}
$ docker run hello-world
Hello from Docker!
...
\`\`\`
`;
}
Expand Down

0 comments on commit d4ddcca

Please sign in to comment.