Skip to content

02 - Setup

Running on NeSI vs on your computer

During this workshop we will be running the material on the NeSI platform, using the Jupyter interface, however it is also possible to run this material locally on your own machine.

One of the differences between running on NeSI or your own machine is that on NeSI we preinstall popular software and make it available to our users, whereas on your own machine you need to install the software yourself (e.g. using a package manager such as conda).

We have provided a guide for setting up your own machine using conda here) (note we will not be able to provide assistance if you decide to take this approach during the workshop).

Connect to Jupyter on NeSI
  1. Connect to https://jupyter.nesi.org.nz

  2. Enter NeSI username, HPC password and 6 digit second factor token (as set on MyNeSI)
    image

  3. Choose server options as below
    make sure to choose the correct project code nesi99991, number of CPUs 4, memory 4GB prior to pressing image button.


image

  1. Start a terminal session from the JupyterLab launcher
    image

Create a working directory

When you connect to NeSI JupyterLab you always start in a new hidden directory. To make sure you can find your work next time, you should change to another location. Here we will switch to our project directory, since home directories can run out of space quickly. If you are using your own project use that instead of "nesi99991".

code

mkdir -p /nesi/project/nesi99991/snakemake20220512/$USER

cd /nesi/project/nesi99991/snakemake20220512/$USER

You can also navigate to the above directory in the JupyterLab file browser, which can be useful for editing files and viewing images and html documents.

Load the Snakemake module

We use "environment modules" on NeSI to manage installed software. This allows you to pick and choose which software is available in your environment. More details about environment modules can be found on the NeSI support page.

The JupyterLab terminal comes with some modules preloaded and it can often be nicer to start with a clean environment:

module purge

We can search for available Snakemake modules using the module spider command:

module spider snakemake

which shows we have many versions of snakemake installed. Now load a specific version of snakemake into your environment:

module load snakemake/7.6.2-gimkl-2020a-Python-3.9.9

Test that the snakemake command is now available by running the following command:

snakemake --version

It should print out the version of snakemake, i.e. "7.6.2".

You can also run module list to see the list of modules that are currently loaded.

Clone this repo

Clone this repo with the following:

code

git clone https://github.com/nesi/snakemake_workshop.git

cd snakemake_workshop

See the Git Guides for information on cloning a repo

Back to homepage