Skip to content

Latest commit

 

History

History
263 lines (180 loc) · 10.6 KB

conda_instructions.md

File metadata and controls

263 lines (180 loc) · 10.6 KB
Raw
layout title
default
Schedule - scRNAseq course

Conda Instructions

In this workshop you will use conda environments to run the exercises. This is because conda environments allow all students to have the save computing environment, i.e. package versions. This enforces reproducibility for you to run this material without the need to re-install or change your local versions. See and graphical example below:

Conda environments are a self-contained directory that you can use in order to reproduce all your results.

Briefly, you need to:

  1. Install Conda and download the .yml file
  2. Create and activate the environment
  3. Deactivate the environment after running your analyses


Install Conda and download the environment file

You should start by installing Conda. We suggest installing either Miniconda3 (NOT Anaconda). After installing Conda, download the course Conda file and put it in your working folder.

On MacOSX

Download MacOX SDK compiler package: MacOSX10.9.sdk.tar.xz

Then extract it, copy it to the /opt/ folder. Conda will use it in that location by default.

#extract
sudo tar -xzf MacOSX10.9.sdk.tar.xz

#copy
sudo cp -r ~/Downloads/MacOSX10.9.sdk /opt/

#give executable permissions
sudo chmod -R a+rX /opt

Then you can install conda:

curl -o Miniconda3-latest-MacOSX-x86_64.sh https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh
sh Miniconda3-latest-MacOSX-x86_64.sh

Follow the instructions on screen replying yes when necessary. Restart your terminal window to apply modifications.

On Ubuntu

Inside Ubuntu, open TERMINAL and type the commands below to install the X-server graphical packages that will be used to launch RStudio. https://docs.anaconda.com/anaconda/install/linux/

sudo apt-get update
sudo apt-get install libgl1-mesa-glx libegl1-mesa libxrandr2 libxrandr2 libxss1 libxcursor1 libxcomposite1 libasound2 libxi6 libxtst6

Then download Miniconda3 and install it.

wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
sh Miniconda3-latest-Linux-x86_64.sh

Follow the instructions on screen replying yes when necessary. Restart your terminal window to apply modifications.

On Windows10

Several packages are not available for Windows. However, on windows10 we can run a Ubuntu subsystem to overcome this issue. Please follow the instructions Alternative option on Windows (WLS) below to install it.


Create a Conda environment from file

To download the environment_macos.yml or environment_linux.yml file using the command on Terminal:

#Ubuntu
wget https://raw.githubusercontent.com/sib-swiss/SchoolRNA2020/master/single_cell/code/environment_linux.yml

#MacOSX
curl -o environment_macos.yml https://raw.githubusercontent.com/sib-swiss/SchoolRNA2020/master/single_cell/code/environment_macos.yml

After this, you should have a file named environment_macos.yml/environment_linux.yml in your directory (it does not matter where, you can save on Downloads folder for example). Next, type:

#MacOSX
conda env create -p sibsinglecell -f environment_macos.yml

#Ubuntu
conda env create -p sibsinglecell -f environment_linux.yml

Several messages will show up on your screen and will tell you about the installation process. This may take a few minutes depending on how many packages are to be installed.

##Collecting package metadata: done
##Solving environment: done
##
##Downloading and Extracting Packages
##libcblas-3.8.0       | 6 KB      | ############################################################################# | 100%
##liblapack-3.8.0      | 6 KB      | ############################################################################# | 100%
##...
##Preparing transaction: done
##Verifying transaction: done
##Executing transaction: done

Activate the environment

Once the environment is created, we need to activate it in order to use the softwares and packages inside it. To activate an environment type:

source activate sibsinglecell

From this point on you can run any of the contents from the course. For instance, you can directly launch RStudio by typing rstudio. Here it is important to add the & symbol in the end to be able to use the command line at the same time if needed. You can open other files from Rstudio later as well.

rstudio ./labs/compiled/my_script.Rmd &

Deactivate the environment

After you've ran all your analyses, you can deactivate the environment by typing:

conda deactivate


Alternative option on Windows (WLS)

Unfortunately, not all packages available on conda are compatible with windows machines. The good news is that is changed on windows10, in which they offer native linux support via the Windows Subsystem for Linux (WSL2). This allows you to run linux/bash commands from within windows without the need of a virtual machine nor a dual-boot setup (i.e. having 2 operational systems). However, WSL does not offer a complete support for graphical interfaces (such as RStudio in our case), so we need an additional steps to make that happen.

  1. On Windows10, install the WSL if you don't have it. Follow the instructions here: https://docs.microsoft.com/en-us/windows/wsl/install-win10

  2. Once you have that installed, you can download and install MobaXterm (which is the enhanced terminal with graphical capacity): https://mobaxterm.mobatek.net

  3. Inside MobaXterm, you will probably will see that your WSL is already listed on the left panel as an available connection. Just double-click it and you will be accessing it via MobaXterm. If by any chance you don't see it there, close MobaXterm and go to the WSL terminal, because probably the WSL is not allowing SSH connections. You can follow this link for the instructions on how to do it. You need to complete until the step Start or restart the SSH service, while the further steps are optional, but might be useful.

  4. Inside MobaXterm, download Conda with the command:

wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
  1. Inside MobaXterm, type the commands below to install Conda. Follow the instructions for the installation there.
cd ~/Downloads
sh Miniconda3-latest-Linux-x86_64.sh
  1. Inside MobaXterm, type the commands below to install the X-server graphical packages that will be used to launch RStudio. https://docs.anaconda.com/anaconda/install/linux/
sudo apt-get update
sudo apt-get install libgl1-mesa-glx libegl1-mesa libxrandr2 libxrandr2 libxss1 libxcursor1 libxcomposite1 libasound2 libxi6 libxtst6
  1. Close Terminal to apply the CONDA updates. Then you can create a course folder, download the environment file and create the environment:
mkdir ~/Desktop/course
cd ~/Desktop/course
wget https://raw.githubusercontent.com/sib-swiss/SchoolRNA2020/glossary_edits/single_cell/code/environment_linux.yml
conda env create -n sibsinglecell -f environment_linux.yml
  1. You can then follow the instructions above to activate/deactivate the environment.
conda activate sibsinglecell
rstudio &


Alternative option (VIRTUALBOX)

If by any means you see that the installations are not working as it should on your computer, you can try to create a virtual machine to run UBUNTU and install everything there.

  1. Download and install on your machine VIRTUALBOX https://www.virtualbox.org

  2. Download the ISO disk of UBUNTU https://ubuntu.com/download/desktop

  3. On VIRTUALBOX, click on Settings (yellow engine) > General > Advanced and make sure that both settings Shared Clipboard and Drag'n'Drop are set to Bidirectional.

  4. Completely close VIRTUALBOX and start it again to apply changes.

  5. On VIRTUALBOX, create a machine called Ubuntu and add the image above

  • set the memory to the maximum allowed in the GREEN bar
  • set the hard disk to be dynamic allocated
  • all other things can be default

  1. Proceed with the Ubuntu installation as recommended. You can set to do "Minimal Installation" and deactivate to get updates during installation.

  2. Inside Ubuntu, open TERMINAL and type the commands below to install the X-server graphical packages that will be used to launch RStudio. https://docs.anaconda.com/anaconda/install/linux/

sudo apt-get update
sudo apt-get install libgl1-mesa-glx libegl1-mesa libxrandr2 libxrandr2 libxss1 libxcursor1 libxcomposite1 libasound2 libxi6 libxtst6
  1. Inside UBUNTU, Download conda:
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
  1. Inside UBUNTU, open the TERMINAL and type the commands below. Follow the instructions for the installation there.
cd ~/Downloads
sh Miniconda3-latest-Linux-x86_64.sh
  1. Close Terminal to apply the CONDA updates. Then you can create a course folder, download the environment file and create the environment:
mkdir ~/Desktop/course
cd ~/Desktop/course

wget https://raw.githubusercontent.com/sib-swiss/SchoolRNA2020/glossary_edits/single_cell/code/environment_linux.yml
conda env create -n sibsinglecell -f environment_linux.yml
  1. You can then follow the instructions above to activate/deactivate the environment.
conda activate sibsinglecell
rstudio &