layout | title | root |
---|---|---|
page |
Setup |
. |
The main requirement for this workshop is a personal computer with a web browser and a command line shell program.
Windows users: MobaXterm is the preferred option. The Portable Edition is best, as it does not require administrative privileges.
In this way you will be able to follow the online materials and to login to a facility with the required software stack.
We will be providing training user accounts to both pre-configured EC2 instances.
This tutorial is supported by the Amazon AWS Machine Learning Research Awards. EC2 images and temporary login credentials will be distributed onsite at the tutorial. Here are setup slides.
After the tutorial, you can boot our tutorial image yourself on Amazon EC2 to run through the tutorial again. We recommend you use your own EC2 key and change the password.
US-West-Oregon: ami-0fe12765123c6a840
In addition to the AWS instances, you can also try running some of the Shifter-based excercises on NERSC's Cori system, a Cray XC40 system. To sign-up for a NERSC tutorial account, visit https://iris.nersc.gov/train and fill out the form. The training code will be provided during the tutorial. Please note that, due to security restrictions, access may be limited but all of the excercises can be done on the AWS instances.
To run the examples yourself, you can download the materials with:
cd ~
git clone https://github.com/supercontainers/sc-tutorials.git
cd sc-tutorials/exercies
Users can also install Docker and Singularity prior to attending the tutorial session. MPICH is required for running the MPI examples, too.
Here, it may be beneficial to create a Docker and Sylabs (Singularity) account in advance at https://cloud.docker.com and https://cloud.sylabs.io. These accounts will be needed to create images on Docker Cloud/DockerHub and Sylabs Cloud.[Install Singularity on Linux]({{ page.root }}/files/install-singularity.sh) | docs
[Install Docker on Linux]({{ page.root }}/files/install-docker.sh) | docs (unofficial)
[Install Charliecloud on Linux]({{ page.root }}/files/install-charliecloud.sh) (uses Spack) | docs
[Install Environment Modules on Linux]({{ page.root }}/files/install-modules.sh) | docs
[Install SHPC on Linux]({{ page.root }}/files/install-shpc.sh) | docs
[Install MPICH on Linux]({{ page.root }}/files/install-mpich.sh) | docs
[Install Nextflow on Linux]({{ page.root }}/files/install-nextflow.sh) | docs
[Install Docker Compose on Linux]({{ page.root }}/files/install-dockercompose.sh) | docs
Note: install scripts have been tested on a Ubuntu machine through a user that can run sudo commands without password prompts. There's no warranty they will work in your Linux box, you should consider them as templates.
For Singularity, you will need to setup a Linux virtual machine, and then follow the same instructions as above.
It's not as bad as it sounds... the main two options are:
- Vagrant: follow these instructions by Sylabs on Setting up Singularity with Vagrant (macOS users: DO NOT use the proposed Singularity Desktop, use Vagrant instead);
- Multipass: follow instructions from the Multipass Homepage.
For Docker, you can download and run installers for macOS and Windows. {: .solution}