Skip to content
This repository was archived by the owner on Aug 14, 2024. It is now read-only.

Commit b8920f7

Browse files
committed
missed a few wrappings
1 parent 3a1500e commit b8920f7

File tree

7 files changed

+94
-76
lines changed

7 files changed

+94
-76
lines changed

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,9 @@ This process requires Ruby, Make, and Jekyll. You can find setup instructions
8585
Some links to example SWC workshop lessons for reference:
8686

8787
* [Example Bash lesson](https://github.com/swcarpentry/shell-novice)
88-
* [Example Python lesson](https://github.com/swcarpentry/python-novice-inflammation)
89-
* [Example R lesson](https://github.com/swcarpentry/r-novice-gapminder) (uses R markdown files
90-
instead of markdown)
88+
* [Example Python lesson](
89+
https://github.com/swcarpentry/python-novice-inflammation)
90+
* [Example R lesson](https://github.com/swcarpentry/r-novice-gapminder)
91+
(uses R markdown files instead of markdown)
9192

9293

_episodes/02-navigation.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -163,8 +163,9 @@ $ cd ~
163163
```
164164
{: .language-bash}
165165
```
166-
bin cvmfs etc initrd lib64 localscratch mnt opt project root sbin srv tmp var
167-
boot dev home lib local media nix proc ram run scratch sys usr work
166+
bin dev initrd local mnt proc root scratch tmp work
167+
boot etc lib localscratch nix project run srv usr
168+
cvmfs home lib64 media opt ram sbin sys var
168169
```
169170
{: .output}
170171

_episodes/03-files.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ Nano defines a number of *shortcut keys* (prefixed by the <kbd>Control</kbd> or
5858
<kbd>Ctrl</kbd> key) to perform actions such as saving the file or exiting the
5959
editor. Here are the shortcut keys for a few common actions:
6060

61-
* <kbd>Ctrl</kbd>+<kbd>O</kbd> &mdash; save the file (into a current name or a new
62-
name).
61+
* <kbd>Ctrl</kbd>+<kbd>O</kbd> &mdash; save the file (into a current name or a
62+
new name).
6363

64-
* <kbd>Ctrl</kbd>+<kbd>X</kbd> &mdash; exit the editor. If you have not saved your
65-
file upon exiting, `nano` will ask you if you want to save.
64+
* <kbd>Ctrl</kbd>+<kbd>X</kbd> &mdash; exit the editor. If you have not saved
65+
your file upon exiting, `nano` will ask you if you want to save.
6666

6767
* <kbd>Ctrl</kbd>+<kbd>K</kbd> &mdash; cut ("kill") a text line. This command
6868
deletes a line and saves it on a clipboard. If repeated multiple times
@@ -180,8 +180,8 @@ draft.txt
180180
```
181181
{: .output}
182182

183-
**Renaming** &mdash; `draft.txt` isn't a very descriptive name. How do we go about
184-
changing it? It turns out that `mv` is also used to rename files and
183+
**Renaming** &mdash; `draft.txt` isn't a very descriptive name. How do we go
184+
about changing it? It turns out that `mv` is also used to rename files and
185185
directories. Although this may not seem intuitive at first, think of it as
186186
*moving* a file to be stored under a different name. The syntax is quite
187187
similar to moving files: `mv oldName newName`.
@@ -207,9 +207,9 @@ newname.testfile
207207
> typically contains text, for instance.
208208
{: .callout}
209209

210-
**Copying** &mdash; What if we want to copy a file, instead of simply renaming or
211-
moving it? Use `cp` command (an abbreviated name for "copy"). This command has
212-
two different uses that work in the same way as `mv`:
210+
**Copying** &mdash; What if we want to copy a file, instead of simply renaming
211+
or moving it? Use `cp` command (an abbreviated name for "copy"). This command
212+
has two different uses that work in the same way as `mv`:
213213

214214
- Copy to same directory (copied file is renamed): `cp file newFilename`
215215
- Copy to other directory (copied file retains original name): `cp file
@@ -340,7 +340,7 @@ $ wget {{site.url}}{{site.baseurl}}/files/bash-lesson.tar.gz
340340
> have it, try this to get it faster than your neighbors:
341341
>
342342
> ```
343-
> $ aria2c {{site.url}}{{site.baseurl}}/files/bash-lesson.tar.gz https://hpc-carpentry.github.io/hpc-shell/files/bash-lesson.tar.gz
343+
> $ aria2c {{ site.url }}{{ site.baseurl }}/files/bash-lesson.tar.gz
344344
> ```
345345
> {: .language-bash}
346346
>

_episodes/04-wildcards-pipes.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,16 @@ $ ls
4848
{: .language-bash}
4949

5050
```
51-
bash-lesson.tar.gz SRR307024_2.fastq SRR307028_1.fastq
52-
dmel-all-r6.19.gtf SRR307025_1.fastq SRR307028_2.fastq
53-
dmel_unique_protein_isoforms_fb_2016_01.tsv SRR307025_2.fastq SRR307029_1.fastq
54-
gene_association.fb SRR307026_1.fastq SRR307029_2.fastq
55-
SRR307023_1.fastq SRR307026_2.fastq SRR307030_1.fastq
56-
SRR307023_2.fastq SRR307027_1.fastq SRR307030_2.fastq
57-
SRR307024_1.fastq SRR307027_2.fastq
51+
bash-lesson.tar.gz SRR307026_1.fastq
52+
dmel-all-r6.19.gtf SRR307026_2.fastq
53+
dmel_unique_protein_isoforms_fb_2016_01.tsv SRR307027_1.fastq
54+
gene_association.fb SRR307027_2.fastq
55+
SRR307023_1.fastq SRR307028_1.fastq
56+
SRR307023_2.fastq SRR307028_2.fastq
57+
SRR307024_1.fastq SRR307029_1.fastq
58+
SRR307024_2.fastq SRR307029_2.fastq
59+
SRR307025_1.fastq SRR307030_1.fastq
60+
SRR307025_2.fastq SRR307030_2.fastq
5861
```
5962
{: .output}
6063

_episodes/05-scripts.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ $ ls -l
9191
-rw-rw-r-- 1 yourUsername tc001 12534006 Jan 16 18:50 bash-lesson.tar.gz
9292
-rw-rw-r-- 1 yourUsername tc001 40 Jan 16 19:41 demo.sh
9393
-rw-rw-r-- 1 yourUsername tc001 77426528 Jan 16 18:50 dmel-all-r6.19.gtf
94-
-rw-r--r-- 1 yourUsername tc001 721242 Jan 25 2016 dmel_unique_protein_isoforms_fb_2016_01.tsv
94+
-rw-r--r-- 1 yourUsername tc001 721242 Jan 25 2016 dmel_unique_protein_is...
9595
drwxrwxr-x 2 yourUsername tc001 4096 Jan 16 19:16 fastq
9696
-rw-r--r-- 1 yourUsername tc001 1830516 Jan 25 2016 gene_association.fb.gz
9797
-rw-rw-r-- 1 yourUsername tc001 15 Jan 16 19:17 test.txt
@@ -146,7 +146,7 @@ $ ls -l
146146
-rw-rw-r-- 1 yourUsername tc001 12534006 Jan 16 18:50 bash-lesson.tar.gz
147147
-rwxrwxr-x 1 yourUsername tc001 40 Jan 16 19:41 demo.sh
148148
-rw-rw-r-- 1 yourUsername tc001 77426528 Jan 16 18:50 dmel-all-r6.19.gtf
149-
-rw-r--r-- 1 yourUsername tc001 721242 Jan 25 2016 dmel_unique_protein_isoforms_fb_2016_01.tsv
149+
-rw-r--r-- 1 yourUsername tc001 721242 Jan 25 2016 dmel_unique_protein_is...
150150
drwxrwxr-x 2 yourUsername tc001 4096 Jan 16 19:16 fastq
151151
-rw-r--r-- 1 yourUsername tc001 1830516 Jan 25 2016 gene_association.fb.gz
152152
-rw-rw-r-- 1 yourUsername tc001 15 Jan 16 19:17 test.txt

lesson-outline.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ title: HPC Carpentry Lesson Outline
66
# UNIX fundamentals on HPC installations
77

88
* SSH to a cluster
9-
* Bash fundamentals (`cd`, `ls`, ..., aliases, functions, ~/.bashrc)
10-
* Transferring files (`scp`? `sftp`? Maybe only one?), maybe adapt
11-
[15-transferring-files.md](https://github.com/carpentries-incubator/hpc-intro/tree/gh-pages/_episodes/15-transferring-files.md)
9+
* Bash fundamentals (`cd`, `ls`, ..., aliases, functions, `~/.bashrc`)
10+
* Transferring files (`scp`? `sftp`? Maybe only one?), maybe adapt
11+
[15-transferring-files.md](
12+
https://github.com/carpentries-incubator/hpc-intro/tree/gh-pages/_episodes/15-transferring-files.md)
1213
* Working with the environment (showing the power of changing `PATH`)
1314
* Introducing modules or similar
1415

setup.md

+61-49
Original file line numberDiff line numberDiff line change
@@ -4,49 +4,55 @@ title: Setup
44
root: .
55
---
66

7-
There are several pieces of software you will wish to install before the workshop. Though
8-
installation help will be provided at the workshop, we recommend that these tools are installed (or
9-
at least downloaded) beforehand.
7+
There are several pieces of software you will wish to install before the
8+
workshop. Though installation help will be provided at the workshop, we
9+
recommend that these tools are installed (or at least downloaded) beforehand.
1010

1111
> ## Bash and SSH
1212
>
13-
> This lesson requires a terminal application (`bash`, `zsh`, or others) with the
14-
> ability to securely connect to a remote machine (`ssh`).
13+
> This lesson requires a terminal application (`bash`, `zsh`, or others) with
14+
> the ability to securely connect to a remote machine (`ssh`).
1515
{: .prereq}
1616

1717
## Where to type commands: How to open a new shell
1818

19-
The shell is a program that enables us to send commands to the computer and receive output. It is
20-
also referred to as the terminal or command line.
19+
The shell is a program that enables us to send commands to the computer and
20+
receive output. It is also referred to as the terminal or command line.
2121

22-
Some computers include a default Unix Shell program. The steps below describe some methods for
23-
identifying and opening a Unix Shell program if you already have one installed. There are also
24-
options for identifying and downloading a Unix Shell program, a Linux/UNIX emulator, or a program
25-
to access a Unix Shell on a server.
22+
Some computers include a default Unix Shell program. The steps below describe
23+
some methods for identifying and opening a Unix Shell program if you already
24+
have one installed. There are also options for identifying and downloading a
25+
Unix Shell program, a Linux/UNIX emulator, or a program to access a Unix Shell
26+
on a server.
2627

2728
### Windows
2829

29-
Computers with Windows operating systems do not automatically have a Unix Shell program installed.
30-
In this lesson, we encourage you to use an emulator included in Git for Windows, which gives you
31-
access to both Bash shell commands and Git. If you have attended a Software Carpentry workshop
32-
session, it is likely you have already received instructions on how to install Git for Windows.
30+
Computers with Windows operating systems do not automatically have a Unix Shell
31+
program installed. In this lesson, we encourage you to use an emulator included
32+
in Git for Windows, which gives you access to both Bash shell commands and Git.
33+
If you have attended a Software Carpentry workshop session, it is likely you
34+
have already received instructions on how to install Git for Windows.
3335

34-
Once installed, you can open a terminal by running the program Git Bash from the Windows start menu.
36+
Once installed, you can open a terminal by running the program Git Bash from
37+
the Windows start menu.
3538

3639
#### Reference
3740

38-
* [Git for Windows](https://gitforwindows.org/) &ndash; *Recommended*
39-
* [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
40-
&ndash; advanced option for Windows 10
41+
* [Git for Windows](https://gitforwindows.org/) &mdash; *Recommended*
42+
* [Windows Subsystem for Linux](
43+
https://docs.microsoft.com/en-us/windows/wsl/install-win10)
44+
&mdash; advanced option for Windows 10
4145

4246
> ## Alternatives to Git for Windows
4347
>
44-
> Other solutions are available for running Bash commands on Windows. There is now a Bash shell
45-
> command-line tool available for Windows 10. Additionally, you can run Bash commands on a remote
46-
> computer or server that already has a Unix Shell, from your Windows machine. This can usually be
47-
> done through a Secure Shell (SSH) client. One such client available for free for Windows computers
48-
> is PuTTY. See the reference below for information on installing and using PuTTY, using the Windows
49-
> 10 command-line tool, or installing and using a Unix/Linux emulator.
48+
> Other solutions are available for running Bash commands on Windows. There is
49+
> now a Bash shell command-line tool available for Windows 10. Additionally,
50+
> you can run Bash commands on a remote computer or server that already has a
51+
> Unix Shell, from your Windows machine. This can usually be done through a
52+
> Secure Shell (SSH) client. One such client available for free for Windows
53+
> computers is PuTTY. See the reference below for information on installing and
54+
> using PuTTY, using the Windows 10 command-line tool, or installing and using
55+
> a Unix/Linux emulator.
5056
>
5157
> For advanced users, you may choose one of the following alternatives:
5258
>
@@ -59,65 +65,71 @@ https://docs.microsoft.com/en-us/powershell/scripting/learn/remoting/ssh-remotin
5965
>
6066
> > ## Warning
6167
> >
62-
> > Commands in the Windows Subsystem for Linux (WSL), Powershell, or Cygwin may differ slightly
63-
> > from those shown in the lesson or presented in the workshop. Please ask if you encounter such
64-
> > a mismatch &ndash; you're probably not alone.
68+
> > Commands in the Windows Subsystem for Linux (WSL), Powershell, or Cygwin
69+
> > may differ slightly from those shown in the lesson or presented in the
70+
> > workshop. Please ask if you encounter such a mismatch &mdash; you're
71+
> > probably not alone.
6572
> {: .challenge}
6673
{: .discussion}
6774

6875
### macOS
6976

70-
On macOS, the default Unix Shell is accessible by running the Terminal program from the `/Application/Utilities` folder in Finder.
77+
On macOS, the default Unix Shell is accessible by running the Terminal program
78+
from the `/Application/Utilities` folder in Finder.
7179

7280
To open Terminal, try one or both of the following:
7381

74-
* In Finder, select the Go menu, then select Utilities. Locate Terminal in the Utilities folder and
75-
open it.
76-
* Use the Mac ‘Spotlight’ computer search function. Search for: `Terminal` and press
77-
<kbd>Return</kbd>.
82+
* In Finder, select the Go menu, then select Utilities. Locate Terminal in the
83+
Utilities folder and open it.
84+
* Use the Mac ‘Spotlight’ computer search function. Search for: `Terminal` and
85+
press <kbd>Return</kbd>.
7886

7987
#### Reference
8088

81-
[How to Use Terminal on a
82-
Mac](http://www.macworld.co.uk/feature/mac-software/how-use-terminal-on-mac-3608274/)
89+
[How to Use Terminal on a Mac](
90+
http://www.macworld.co.uk/feature/mac-software/how-use-terminal-on-mac-3608274/)
8391

8492
### Linux
8593

86-
On most versions of Linux, the default Unix Shell
87-
is accessible by running the [(Gnome) Terminal](https://help.gnome.org/users/gnome-terminal/stable/)
88-
or [(KDE) Konsole](https://konsole.kde.org/) or [xterm](https://en.wikipedia.org/wiki/Xterm), which
89-
can be found via the applications menu or the search bar.
94+
On most versions of Linux, the default Unix Shell is accessible by running the
95+
[(Gnome) Terminal](https://help.gnome.org/users/gnome-terminal/stable/) or
96+
[(KDE) Konsole](https://konsole.kde.org/) or
97+
[xterm](https://en.wikipedia.org/wiki/Xterm), which can be found via the
98+
applications menu or the search bar.
9099

91100
### Special cases
92101

93-
If none of the options above address your circumstances, try an online search for: `Unix shell [your operating system]`.
102+
If none of the options above address your circumstances, try an online search
103+
for: `Unix shell [your operating system]`.
94104

95105
## SSH for Secure Connections
96106

97-
All students should have an SSH client installed. SSH is a tool that allows us to connect to and
98-
use a remote computer as our own.
107+
All students should have an SSH client installed. SSH is a tool that allows us
108+
to connect to and use a remote computer as our own.
99109

100110
### Windows
101111

102112
Git for Windows comes with SSH preinstalled: you do not have to do anything.
103113

104114
> ## GUI Support
105115
>
106-
> If you know that the software you will be running on the cluster requires a graphical user
107-
> interface (a GUI window needs to open for the application to run properly), please install
108-
> [MobaXterm](http://mobaxterm.mobatek.net) Home Edition.
116+
> If you know that the software you will be running on the cluster requires a
117+
> graphical user interface (a GUI window needs to open for the application to
118+
> run properly), please install [MobaXterm](http://mobaxterm.mobatek.net) Home
119+
> Edition.
109120
{: .discussion}
110121

111122
### macOS
112123

113-
macOS comes with SSH pre-installed: you do not have to do anything.
124+
macOS comes with SSH pre-installed: you do not have to do anything.
114125

115126
> ## GUI Support
116127
>
117-
> If you know that the software you will be running requires a graphical user interface, please
118-
> install [XQuartz](www.xquartz.org).
128+
> If you know that the software you will be running requires a graphical user
129+
> interface, please install [XQuartz](www.xquartz.org).
119130
{: .discussion}
120131

121132
### Linux
122133

123-
Linux comes with SSH and X window support preinstalled: you do not have to do anything.
134+
Linux comes with SSH and X window support preinstalled: you do not have to do
135+
anything.

0 commit comments

Comments
 (0)