Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _includes/install_instructions/python.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ <h3>Python</h3>

<p>
Regardless of how you choose to install it,
<strong>please make sure you install a Python version >= 3.9</strong>
(e.g. 3.11 is fine, 3.6 is not).
<strong>please make sure you install the most recent Python version available</strong>.
You can check this by going to https://www.python.org/downloads/latest/.
Comment on lines +22 to +23
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<strong>please make sure you install the most recent Python version available</strong>.
You can check this by going to https://www.python.org/downloads/latest/.
<strong>please install the most recent Python version available</strong>
by going to the <a href="https://www.python.org/downloads/latest/">latest download site</a> and scrolling to the Files section to find the download for your operating system.

</p>

{% comment %}
Expand Down
196 changes: 89 additions & 107 deletions _includes/install_instructions/shell.html
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
<div id="shell">
<h3>The Bash Shell</h3>
<p>
Bash is a commonly-used shell that gives you the power to do
tasks more quickly.
Bash is a commonly-used shell that gives you the power to do tasks more quickly.
</p>

<div>
Expand All @@ -16,12 +15,10 @@ <h3>The Bash Shell</h3>
<article role="tabpanel" class="tab-pane outer-tab active" id="shell-windows">
<p>Two options are available for setting up your device so that you’re ready to learn in our workshops with Microsoft Windows.</p>

<p>The first is Windows Subsystem for Linux v2 (“WSL 2”), and the second is Git for Windows (often referred to as “Git Bash”).</p>

<p>Please follow the instructions below, depending on <a href="#shell-windows-check">which version of Windows you are using</a>. If unsure, use the asterisk marked version <strong>*</strong>.</p>
<p>The first is Git for Windows (often referred to as “Git Bash”), and the second is Windows Subsystem for Linux v2 (“WSL 2”).</p>

<div class="alert alert-warning">
<strong>To install WSL 2, you will need Administrator (“admin”) privileges on your laptop/PC.</strong><br>
<strong>If you choose to install WSL 2, you will need Administrator (“admin”) privileges on your laptop/PC.</strong><br>
If you have a device provided by an institution that does not give you admin rights, please either request that they:
<ul>
<li>Give you admin rights (temporarily or otherwise) to install WSL 2 yourself OR</li>
Expand All @@ -33,32 +30,14 @@ <h3>The Bash Shell</h3>
<strong>If you experience any issues, please install Git for Windows using the <a class="os-switch" data-software="gitbash" href="#shell-install-gitbash">instructions below</a>.</strong>
</p>

<table>
<tr>
<th>Windows Version</th>
<th>What to Install</th>
</tr>
<tr>
<td>Windows 8.1 or earlier</td>
<td><a class="os-switch" data-software="gitbash" href="#shell-install-gitbash">Install Git for Windows</a></td>
</tr>
<tr>
<td>Windows 10 (#1902 and below)</td>
<td><a class="os-switch" data-software="gitbash" href="#shell-install-gitbash">Install Git for Windows</a></td>
</tr>
<tr>
<td>Windows 10 (#1903 and above)</td>
<td><a class="os-switch" data-software="wsl" href="#shell-install-wsl">Install WSL 2</a></td>
</tr>
<tr>
<td>Windows 11 <strong>*</strong></td>
<td><a class="os-switch" data-software="wsl" href="#shell-install-wsl">Install WSL 2</a></td>
</tr>
</table>

<details>
<summary>Help! What should I use?</summary>
<div class="alert alert-warning">
<p>
We recommend Git for Windows as the default bash experience for Windows users attending our workshops, as it is the most straightforward to install and use, and does not require admin privileges.
However, it has limited functionality compared to a full Linux environment, and when you continue your data science learning after the workshop you will find that Git Bash does not support all the tools and workflows you might need.
We recommend that after the workshop, you consider installing WSL 2 to get a more complete Linux experience within your Windows environment, and to have access to the full range of tools and software available on Linux.
</p>
<p>
<h4 id="shell-windows-check">Checking your Windows Version</h4>
Click on the Windows Start Menu button in the bottom left corner of your screen, or tap the Windows button on your keyboard, and type “System” in the search bar.
Expand All @@ -85,94 +64,21 @@ <h4 id="shell-windows-10-1902">Windows 10 (earlier than version #1903)</h4>
<br/>
<p>
<h4 id="shell-windows-10-11">Windows 10 (version #1903 and later) and Windows 11</h4>
WSL 2 is recommended for more modern versions of Windows as it provides an accurate and representative experience of Linux, but provided from within your Windows environment.
Windows 11 and later versions of Windows 10 support WSL 2, so following the workshop where you will use Git Bash, we recommend that you consider installing WSL2.
If you are not comfortable installing WSL 2, please follow the Git for Windows <a href="#shell-git">installation instructions</a> below.
</p>
</div>
</details>

<ul class="nav nav-tabs" role="tablist" id="win-tabs">
<li role="presentation" class="active"><a data-software="wsl" href="#shell-install-wsl" aria-controls="shell-wsl" role="tab" data-toggle="tab">WSL 2</a></li>
<li role="presentation"><a data-software="gitbash" href="#shell-install-gitbash" aria-controls="shell-gitbash" role="tab" data-toggle="tab">Git for Windows</a></li>
<li role="presentation" class="active"><a data-software="gitbash" href="#shell-install-gitbash" aria-controls="shell-gitbash" role="tab" data-toggle="tab">Git for Windows</a></li>
<li role="presentation"><a data-software="wsl" href="#shell-install-wsl" aria-controls="shell-wsl" role="tab" data-toggle="tab">WSL 2</a></li>
</ul>

<div class="tab-content">
<article role="tabpanel" class="tab-pane active" id="shell-install-wsl" aria-labelledby="tab-wsl">
<h3>Installing WSL 2</h3>

<p>
We will install Ubuntu via the <a href="#shell-windows-wsl-store">Microsoft Store</a>.
It is possible to install WSL within the Windows Powershell command prompt, and <a href="https://learn.microsoft.com/en-gb/windows/wsl/install">full instructions</a> are on the Microsoft website.
<br>
<strong>Note:</strong> You will need to restart your computer after installing WSL 2, so make sure you have saved any work.
</p>

<details>
<summary>Why Ubuntu?</summary>
<div class="alert alert-warning">
<p>
Linux comes in many flavours, called <a href="https://en.wikipedia.org/wiki/Linux_distribution">“distributions”</a>, and each has its own benefits, features and quirks!
</p>
<p>
WSL 2 is a fully fledged Linux environment that runs completely within your Windows 10 or 11 operating system.
While there are many Linux distributions available to install (e.g. Ubuntu, Debian, Fedora, Mint, Arch, Gentoo, and hundreds more!), WSL 2 only supports a handful of distributions listed above due to the way it needs to be integrated with Windows itself.
</p>
<p>
So, we will use the default that WSL 2 recommends, Ubuntu.
</p>
</div>
</details>

<h4 id="shell-windows-wsl-store">Via the Microsoft Store:</h4>
<ol>
<li>Open the Windows Start Menu button in the bottom left corner of your screen (four blue squares), or tap the <kbd>Win</kbd> Windows button on your keyboard (between the bottom left <kbd>CTRL</kbd> and <kbd>ALT</kbd> keys) and search “store”. Open the Microsoft Store.</li>
<li>In the Microsoft Store search bar, type “wsl ubuntu”, and select the Ubuntu 22.04 or 24.04 option (at the time of writing, <code>Ubuntu 22.04.06 LTS</code>, or <code>Ubuntu 24.04.01 LTS</code>):
<ul>
<li>If a pop-up window appears asking if you want to make changes to your device, select “Yes”</li>
<li>The install should proceed, and this can take a few minutes depending on your PC performance and internet download speed.</li>
<li>Once installed, restart the computer.</li>
</ul>
</li>
<li>Once restarted, reopen the Windows Start Menu button in the bottom left corner of your screen, or tap the Windows button on your keyboard. In the search bar, type either:
<ul>
<li><code>Ubuntu</code>: selecting <code>Ubuntu 22.04.06 LTS</code> or <code>Ubuntu 24.04.01 LTS</code> from the Start Menu will open the bash prompt directly, or</li>
<li><code>Terminal</code>: this will open a new Windows Terminal window, which will look like a blank black window with a blinking cursor waiting for input. <strong>Note:</strong> This terminal might default to Powershell, and not Ubuntu. If this is the case, click the down arrow in the Terminal window menu bar at the top, and then click Ubuntu 22.04 or 24.04, depending on the version you installed. It will also show keyboard shortcuts (e.g. Ctrl+Shift+1) to open the various prompts available within the Terminal application.</li>
</ul>
</li>
<li>Follow the <a href="#shell-windows-wsl-install-software">Installing software within WSL 2</a> section below.</li>
</ol>

<h4 id="shell-windows-wsl-install-software">Installing software within WSL 2</h4>
<p>
Once you have installed WSL 2, you will need to install some software within the Ubuntu operating system in order to use it effectively. Make sure you are using Ubuntu by checking you see the bash prompt:
<img src="assets/img/wsl2_example.png" alt="Ubuntu terminal running bash and showing the Ubuntu version">
</p>

<p>
The first thing to do is to update the list of available Ubuntu software packages, using a tool called <code>apt</code>.
Type the following command into the bash prompt:
<code>sudo apt update</code>
</p>
<p>
<strong>Note:</strong> You will be prompted to enter your password. This is the password you set when installing Ubuntu, and will not show up on the screen as you type it in.
This is a security feature of the terminal, and is normal behaviour.
</p>
<p>
Install updated versions of the base packages required across all our lessons, by typing:
<ul>
<li><code>sudo apt install git build-essential autoconf automake libtool python3 r-base</code></li>
</ul>
</p>
<p>
You're all set!
</p>
<strong>If you get stuck, please contact your workshop organisers to get assistance before the workshop starts.</strong>
</article>

<article role="tabpanel" class="tab-pane" id="shell-install-gitbash" aria-labelledby="tab-wsl">
<article role="tabpanel" class="tab-pane active" id="shell-install-gitbash" aria-labelledby="tab-wsl">
<h3>Installing Git for Windows</h3>
<p>
<strong>If you are unable to use WSL 2, please use the following instructions to install Git for Windows (“Git Bash”).</strong>
</p>

<ol>
<li>Download the Git for Windows <a href="https://gitforwindows.org/">installer</a>.</li>
Expand Down Expand Up @@ -264,6 +170,82 @@ <h4>Video Tutorial</h4>
</div>
</div>
</article>

<article role="tabpanel" class="tab-pane" id="shell-install-wsl" aria-labelledby="tab-wsl">
<h3>Installing WSL 2</h3>

<p>
<strong>If you are confident to try installing WSL 2 rather than Git Bash, please use the following instructions.</strong>
</p>

<p>
We will install Ubuntu via the <a href="#shell-windows-wsl-store">Microsoft Store</a>.
It is possible to install WSL within the Windows Powershell command prompt, and <a href="https://learn.microsoft.com/en-gb/windows/wsl/install">full instructions</a> are on the Microsoft website.
<br>
<strong>Note:</strong> You will need to restart your computer after installing WSL 2, so make sure you have saved any work.
</p>

<details>
<summary>Why Ubuntu?</summary>
<div class="alert alert-warning">
<p>
Linux comes in many flavours, called <a href="https://en.wikipedia.org/wiki/Linux_distribution">“distributions”</a>, and each has its own benefits, features and quirks!
</p>
<p>
WSL 2 is a fully fledged Linux environment that runs completely within your Windows 10 or 11 operating system.
While there are many Linux distributions available to install (e.g. Ubuntu, Debian, Fedora, Mint, Arch, Gentoo, and hundreds more!), WSL 2 only supports a handful of distributions listed above due to the way it needs to be integrated with Windows itself.
</p>
<p>
So, we will use the default that WSL 2 recommends, Ubuntu.
</p>
</div>
</details>

<h4 id="shell-windows-wsl-store">Via the Microsoft Store:</h4>
<ol>
<li>Open the Windows Start Menu button in the bottom left corner of your screen (four blue squares), or tap the <kbd>Win</kbd> Windows button on your keyboard (between the bottom left <kbd>CTRL</kbd> and <kbd>ALT</kbd> keys) and search “store”. Open the Microsoft Store.</li>
<li>In the Microsoft Store search bar, type “wsl ubuntu”, and select the Ubuntu 22.04 or 24.04 option (at the time of writing, <code>Ubuntu 22.04.06 LTS</code>, or <code>Ubuntu 24.04.01 LTS</code>):
<ul>
<li>If a pop-up window appears asking if you want to make changes to your device, select “Yes”</li>
<li>The install should proceed, and this can take a few minutes depending on your PC performance and internet download speed.</li>
<li>Once installed, restart the computer.</li>
</ul>
</li>
<li>Once restarted, reopen the Windows Start Menu button in the bottom left corner of your screen, or tap the Windows button on your keyboard. In the search bar, type either:
<ul>
<li><code>Ubuntu</code>: selecting <code>Ubuntu 22.04.06 LTS</code> or <code>Ubuntu 24.04.01 LTS</code> from the Start Menu will open the bash prompt directly, or</li>
<li><code>Terminal</code>: this will open a new Windows Terminal window, which will look like a blank black window with a blinking cursor waiting for input. <strong>Note:</strong> This terminal might default to Powershell, and not Ubuntu. If this is the case, click the down arrow in the Terminal window menu bar at the top, and then click Ubuntu 22.04 or 24.04, depending on the version you installed. It will also show keyboard shortcuts (e.g. Ctrl+Shift+1) to open the various prompts available within the Terminal application.</li>
</ul>
</li>
<li>Follow the <a href="#shell-windows-wsl-install-software">Installing software within WSL 2</a> section below.</li>
</ol>

<h4 id="shell-windows-wsl-install-software">Installing software within WSL 2</h4>
<p>
Once you have installed WSL 2, you will need to install some software within the Ubuntu operating system in order to use it effectively. Make sure you are using Ubuntu by checking you see the bash prompt:
<img src="assets/img/wsl2_example.png" alt="Ubuntu terminal running bash and showing the Ubuntu version">
</p>

<p>
The first thing to do is to update the list of available Ubuntu software packages, using a tool called <code>apt</code>.
Type the following command into the bash prompt:
<code>sudo apt update</code>
</p>
<p>
<strong>Note:</strong> You will be prompted to enter your password. This is the password you set when installing Ubuntu, and will not show up on the screen as you type it in.
This is a security feature of the terminal, and is normal behaviour.
</p>
<p>
Install updated versions of the base packages required across all our lessons, by typing:
<ul>
<li><code>sudo apt install git build-essential autoconf automake libtool python3 r-base</code></li>
</ul>
</p>
<p>
You're all set!
</p>
<strong>If you get stuck, please contact your workshop organisers to get assistance before the workshop starts.</strong>
</article>
</div>
</article>

Expand Down