Setup
Overview
Teaching: 15 min
Exercises: 0 minQuestions
Download files required for the lesson.
Objectives
Install the Bash shell.
Install the Atom code editor.
Install the Python environment.
Download the sample data files.
Installation Instructions
To participate in the workshop, you will need access to the software described below. In addition, you will need an up-to-date web browser.
We maintain a list of common issues that occur during installation as a reference for instructors that may be useful on the Configuration Problems and Solutions wiki page.
The Bash Shell
Bash is a commonly-used shell that gives you the power to do simple tasks more quickly.
- Download the Git for Windows installer.
- Run the installer and follow the steps below:
- Click on "Next" four times (two times if you've previously installed Git). You don't need to change anything in the Information, location, components, and start menu screens.
- Select "Use the nano editor by default" and click on "Next".
- Keep "Git from the command line and also from 3rd-party software" selected and click on "Next". If you forgot to do this programs that you need for the workshop will not work properly. If this happens rerun the installer and select the appropriate option.
- Click on "Next".
- Select "Use the native Windows Secure Channel library", and click "Next".
- Keep "Checkout Windows-style, commit Unix-style line endings" selected and click on "Next".
- Select "Use Windows' default console window" and click on "Next".
- Leave all three items selected, and click on "Next".
- Do not select the experimental option. Click "Install".
- Click on "Finish".
-
If your "HOME" environment variable is not set (or you don't know what this is):
- Open command prompt (Open Start Menu then type
cmdand press Enter) -
Type the following line into the command prompt window exactly as shown:
setx HOME "%USERPROFILE%" - Press Enter, you should see
SUCCESS: Specified value was saved. - Quit command prompt by typing
exitthen pressing Enter
- Open command prompt (Open Start Menu then type
This will provide you with both Git and Bash in the Git Bash program.
The default shell in all versions of macOS is Bash, so no
need to install anything. You access Bash from the Terminal
(found in
/Applications/Utilities).
See the Git installation video tutorial
for an example on how to open the Terminal.
You may want to keep
Terminal in your dock for this workshop.
The default shell is usually Bash, but if your
machine is set up differently you can run it by opening a
terminal and typing bash. There is no need to
install anything.
Text Editor
When you're writing code, it's nice to have a text editor that is optimized for writing code, with features like automatic color-coding of key words. The default text editor on Mac OS X and Linux is usually set to Vim, which, although very powerful, is not the most intuitive. If you accidentally find yourself stuck in it, hit the Esc key, followed by :+q+! (colon, lower-case 'q', exclamation mark), then hit Return to return to the shell.
atom is a free, high-quality code editor and
the default that instructors use in the workshop. Once you have installed
atom (see below) you should be able to, from the shell, enter atom
newfile.txt to start editing a file.
To install atom, go here and select the options for Windows installation. Follow all instructions, selecting defaults where there are choices.
Some other editors that you can use are Notepad++ or Sublime Text.
To install atom, go here and select the options for Mac installation. Follow all instructions, selecting defaults where there are choices.
Some other editors that you can use are Text Wrangler or Sublime Text.
To install atom, go here and select the options for your Linux (.deb for Ubuntu or similar, .rpm for Fedora or similar) installation. Follow all instructions, selecting defaults where there are choices.
Other editors that you can use are Gedit, Kate or Sublime Text.
Python
Python is a popular language for research computing, and great for general-purpose programming as well. Installing all of its research packages individually can be a bit difficult, so we recommend Anaconda, an all-in-one installer.
Regardless of how you choose to install it, please make sure you install Python version 3.x (e.g., 3.7 is fine). Do not install version 2.7.
- Open https://www.anaconda.com/download/#windows with your web browser.
- Download the Python 3 installer for Windows.
- Install Python 3 using all of the defaults for installation except make sure to check Add Anaconda to my PATH environment variable.
- Open https://www.anaconda.com/download/#macos with your web browser.
- Download the Python 3 installer for OS X.
- Install Python 3 using all of the defaults for installation.
- Open https://www.anaconda.com/download/#linux with your web browser.
- Download the Python 3 installer for Linux.
(The installation requires using the shell. If you aren't comfortable doing the installation yourself stop here and request help at the workshop.) - Open a terminal window.
-
Type
bash Anaconda3-
and then press Tab. The name of the file you just downloaded should appear. If it does not, navigate to the folder where you downloaded the file, for example with:cd Downloads
Then, try again. -
Press Return. You will follow the text-only prompts. To move through
the text, press Spacebar. Type
yesand press enter to approve the license. Press enter to approve the default location for the files. Typeyesand press enter to prepend Anaconda to yourPATH(this makes the Anaconda distribution the default Python). - Close the terminal window.
Setting up your environment
- Create a directory called
may-python. - Enter into that directory (unless otherwise stated, we will assume you are in this directory).
Getting the data
- From your browser, download may-python-intermediate-data.zip.
- Find the file using your file explorer, and unzip the file into your
may-pythondirectory. - There should now be a
datadirectory withinmay-python.
Key Points