Skip to content

Latest commit

 

History

History
90 lines (55 loc) · 3.46 KB

setup.md

File metadata and controls

90 lines (55 loc) · 3.46 KB
Raw

Software Setup

Choose an option below.

Option 1: Google co-labs

Easy (No software installation; Works for any OS)

Video Guide

  1. Visit https://colab.research.google.com

  2. Click the GITHUB tab

  3. Enter "gw-odw/odw-2020" in the search bar, and click enter to search

  4. Double click the notebook of your choice

  5. At the top of the notebook, uncomment any pip install commands by removing the #

#! pip install -q 'gwpy==1.0.1 <-- Remove the # and run

(you will probably see the warning: Unrecognised runtime "igwin-py37"; defaulting to "python3". Don't worry it is an expected behaviour)

  1. Click run all from the runtime menu at the top

Option 2: Run in mybinder

Easy (No software installation; Works for any OS)

Binder

Option 3: You have a Linux or Apple/Mac computer -- Use conda

Intermediate (Some software installation; Will not work on Windows PC)

Note: this workshop will use Python version 3.7

  1. Install miniconda: https://conda.io/en/latest/miniconda.html
    Choose the version for Python 3.7. See the installation instructions here: https://conda.io/projects/conda/en/latest/user-guide/install/ You may need to restart your computer after installation.

  2. Download the IGWN YML file for the IGWN Conda Distribution

  1. Add the conda-forge channel
    conda config --add channels conda-forge

  2. Create the environment
    conda env create --file igwn-py37.yaml

  3. Clone the workshop git repo
    git clone https://github.com/gw-odw/odw-2020.git

  4. Move into the directory with the workshop git repo
    cd odw-2020

  5. Activate the environment
    conda activate igwn-py37

  6. Update the gwosc package at the version 0.5.3 that will be used for this workshop
    conda install gwosc=0.5.3

  7. Build a custom jupyter kernel using the command
    ipython kernel install --user --name=igwn-py37
    or equivalently
    python -m ipykernel install --user --name=igwn-py37

  8. Start the jupyter notebook server
    jupyter notebook and select the kernel igwn-py37 if this is not done by default.

Troubleshooting:

  • The kernel igwn-py37 should appear in the list returned by the command jupyter kernelspec list executed in a terminal
  • If, when you run jupyter, you get the message: Could not find kernel matching igwn-py37. Please select a kernel: Python 3 this indicates the igwn-py37 kernel is not installed properly. Make sure you executed step 9)

Option 4: Linux install on Windows 10 with dedicated app (Windows 10 only)

Advanced (For Windows 10)

Install a Linux distribution on your Windows system. See instructions here: https://docs.microsoft.com/en-us/windows/wsl/install-win10

We suggest you install Debian GNU/Linux, which is the closest distribution to what is used currently by LIGO/Virgo. Once you have Linux installed, follow the instructions in Option 3.