layout | carpentry | venue | address | country | language | latlng | humandate | humantime | startdate | enddate | instructor | helper | collaborative_notes | eventbrite | ||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
workshop |
FIXME |
Software setups for Carpentry workshops |
FIXME |
FIXME |
FIXME |
FIXME |
FIXME |
FIXME |
|
|
{% comment %} See instructions in the comments below for how to edit specific sections of this workshop template. {% endcomment %}
{% comment %} HEADER
Edit the values in the block above to be appropriate for your workshop. If the value is not 'true', 'false', 'null', or a number, please use double quotation marks around the value, unless specified otherwise. And run 'make workshop-check' before committing to make sure that changes are good. {% endcomment %}
{% comment %} EVENTBRITE
This block includes the Eventbrite registration widget if 'eventbrite' has been set in the header. You can delete it if you are not using Eventbrite, or leave it in, since it will not be displayed if the 'eventbrite' field in the header is not set. {% endcomment %} {% if page.eventbrite %}
<iframe src="https://www.eventbrite.com/tickets-external?eid={{page.eventbrite}}&ref=etckt" frameborder="0" width="100%" height="248px" scrolling="auto"> </iframe> {% endif %}{% comment %} SETUP
Delete irrelevant sections from the setup instructions. Each section is inside a 'div' without any classes to make the beginning and end easier to find.
This is the other place where people frequently make mistakes, so please preview your site before committing, and make sure to run 'tools/check' as well. {% endcomment %}
To participate in a {% if page.carpentry == "swc" %} Software Carpentry {% elsif page.carpentry == "dc" %} Data Carpentry {% elsif page.carpentry == "lc" %} Library Carpentry {% endif %} 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.
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 bellow:
-
{% comment %} Git 2.8.2 Setup {% endcomment %}
{% comment %} Information {% endcomment %}
- Click on "Next". {% comment %} Select Components {% endcomment %}
- Click on "Next". {% comment %} Adjusting your PATH environment {% endcomment %}
- Keep "Use Git from the Windows Command Prompt" 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. {% comment %} Choosing the SSH executable {% endcomment %}
- Click on "Next". {% comment %} Configuring the line ending conversions {% endcomment %}
- Keep "Checkout Windows-style, commit Unix-style line endings" selected and click on "Next". {% comment %} Configuring the terminal emulator to use with Git Bash {% endcomment %}
- Keep "Use Windows' default console window" selected and click on "Next". {% comment %} Configuring experimental performance tweaks {% endcomment %}
- Click on "Install". {% comment %} Installing {% endcomment %} {% comment %} Completing the Git Setup Wizard {% endcomment %}
- 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
cmd
and 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
exit
then 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.
Git is a version control system that lets you track who made changes to what when and has options for easily updating a shared or public version of your code on github.com. You will need a supported web browser (current versions of Chrome, Firefox or Safari, or Internet Explorer version 9 or above).
You will need an account at github.com for parts of the Git lesson. Basic GitHub accounts are free. We encourage you to create a GitHub account if you don't have one already. Please consider what personal information you'd like to reveal. For example, you may want to review these instructions for keeping your email address private provided at GitHub.
For OS X 10.9 and higher, install Git for Mac
by downloading and running the most recent "mavericks" installer from
this list.
After installing Git, there will not be anything in your /Applications
folder,
as Git is a command line program.
For older versions of OS X (10.5-10.8) use the
most recent available installer labelled "snow-leopard"
available here.
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 macOS and
Linux is usually set to Vim, which is not famous for being
intuitive. if you accidentally find yourself stuck in it, try
typing the escape key, followed by :q!
(colon, lower-case 'q',
exclamation mark), then hitting Return to return to the shell.
nano is a basic editor and the default that instructors use in the workshop. To install it, download the {% if page.carpentry == "swc" %} Software Carpentry {% elsif page.carpentry == "dc" %} Data Carpentry {% elsif page.carpentry == "lc" %} Library Carpentry {% endif %} Windows installer and double click on the file to run it. This installer requires an active internet connection.
Others editors that you can use are Notepad++ or Sublime Text. Be aware that you must add its installation directory to your system path. Please ask your instructor to help you do this.
nano is a basic editor and the default that instructors use in the workshop. See the Git installation video tutorial for an example on how to open nano. It should be pre-installed.
Others editors that you can use are Text Wrangler or Sublime Text.
nano is a basic editor and the default that instructors use in the workshop. It should be pre-installed.
Others editors that you can use are Gedit, Kate or Sublime Text.
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.
<p>
Regardless of how you choose to install it,
<strong>please make sure you install Python version 3.x</strong>
(e.g., 3.6 is fine).
</p>
<p>
We will teach Python using the <a href="https://jupyter.org/">Jupyter notebook</a>,
a programming environment that runs in a web browser. For this to work you will need a reasonably
up-to-date browser. The current versions of the Chrome, Safari and
Firefox browsers are all
<a href="https://jupyter-notebook.readthedocs.io/en/stable/notebook.html#browser-compatibility">supported</a>
(some older browsers, including Internet Explorer version 9
and below, are not).
</p>
- 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 Make Anaconda the default Python.
- 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 enter. You will follow the text-only prompts. To move through
the text, press the space key. Type
yes
and press enter to approve the license. Press enter to approve the default location for the files. Typeyes
and press enter to prepend Anaconda to yourPATH
(this makes the Anaconda distribution the default Python). - Close the terminal window.
Once you are done installing the software listed above, please go to this page, which has instructions on how to test that everything was installed correctly.
{% endcomment %}R is a programming language that is especially powerful for data exploration, visualization, and statistical analysis. To interact with R, we use RStudio.
Install R by downloading and running this .exe file from CRAN. Also, please install the RStudio IDE. Note that if you have separate user and admin accounts, you should run the installers as administrator (right-click on .exe file and select "Run as administrator" instead of double-clicking). Otherwise problems may occur later, for example when installing R packages.
Install R by downloading and running this .pkg file from CRAN. Also, please install the RStudio IDE.
You can download the binary files for your distribution
from CRAN. Or
you can use your package manager (e.g. for Debian/Ubuntu
run sudo apt-get install r-base
and for Fedora run
sudo dnf install R
). Also, please install the
RStudio IDE.
SQL is a specialized programming language used with databases. We use a simple database manager called SQLite in our lessons.
Carpentries is now usinsg a tool called DB Browser for SQLite. The install is for all platforms.
For this lesson you will need OpenRefine and a web browser. Note: this is a Java program that runs on your machine (not in the cloud). It runs inside a web browser, but no web connection is needed.
Check that you have either the Firefox or the Chrome browser installed and set as your default browser. OpenRefine runs in your default browser. It will not run correctly in Internet Explorer.
Download software from http://openrefine.org/
Create a new directory called OpenRefine.
Unzip the downloaded file into the OpenRefine directory by right-clicking and selecting "Extract ...".
Go to your newly created OpenRefine directory.
Launch OpenRefine by clicking google-refine.exe
(this will launch a command prompt window, but you can ignore that - just wait for OpenRefine to open in the browser).
If you are using a different browser, or if OpenRefine does not automatically open for you, point your browser at http://127.0.0.1:3333/ or http://localhost:3333 to use the program.
Check that you have either the Firefox or the Chrome browser installed and set as your default browser. OpenRefine runs in your default browser. It may not run correctly in Safari.
Download software from http://openrefine.org/.
Create a new directory called OpenRefine.
Unzip the downloaded file into the OpenRefine directory by double-clicking it.
Go to your newly created OpenRefine directory.
Launch OpenRefine by dragging the icon into the Applications folder.
Use Ctrl-click/Open ...
to launch it.
If you are using a different browser, or if OpenRefine does not automatically open for you, point your browser at http://127.0.0.1:3333/ or http://localhost:3333 to use the program.
Check that you have either the Firefox or the Chrome browser installed and set as your default browser. OpenRefine runs in your default browser.
Download software from http://openrefine.org/.
Make a directory called OpenRefine.
Unzip the downloaded file into the OpenRefine directory.
Go to your newly created OpenRefine directory.
Launch OpenRefine by entering ./refine
into the terminal within the OpenRefine directory.
If you are using a different browser, or if OpenRefine does not automatically open for you, point your browser at http://127.0.0.1:3333/ or http://localhost:3333 to use the program.
{% comment %}
Some instructors prefer to have learners use a virtual machine (VM) rather than install software on their own computers. If your instructors have chosen to do this, please:
- Install VirtualBox.
- Download our VM image. Warning: this file is 1.7 GByte, so please download it before coming to your workshop.
-
Load the VM into VirtualBox by selecting "Import Appliance" and
loading the
.ova
file.