From 686e68322bfc8ee56a40b57b350050b9901aafe4 Mon Sep 17 00:00:00 2001 From: Dinindu Senanayake Date: Sun, 28 Jul 2024 13:12:16 +1200 Subject: [PATCH] upate syntax --- docs/01-introduction.md | 56 +++++++---------------------------- docs/02-the-filesystem.md | 28 +++++++----------- docs/03-working-with-files.md | 27 +++++++---------- docs/04-redirection.md | 23 ++++++-------- docs/05-writing-scripts.md | 22 +++++--------- docs/06-organization.md | 23 ++++++-------- docs/index.md | 2 ++ 7 files changed, 61 insertions(+), 120 deletions(-) diff --git a/docs/01-introduction.md b/docs/01-introduction.md index d4bdefe..f9e33aa 100644 --- a/docs/01-introduction.md +++ b/docs/01-introduction.md @@ -1,26 +1,20 @@ ---- -title: Introducing the Shell -teaching: 20 -exercises: 10 ---- +# 1. Introducing the Shell -::::::::::::::::::::::::::::::::::::::: objectives +!!! clipboard-list "Lesson Objectives" -- Describe key reasons for learning shell. -- Navigate your file system using the command line. -- Access and read help files for `bash` programs and use help files to identify useful command options. -- Demonstrate the use of tab completion, and explain its advantages. + - Describe key reasons for learning shell. + - Navigate your file system using the command line. + - Access and read help files for `bash` programs and use help files to identify useful command options. + - Demonstrate the use of tab completion, and explain its advantages. -:::::::::::::::::::::::::::::::::::::::::::::::::: -:::::::::::::::::::::::::::::::::::::::: questions +!!! clipboard-question "questions" -- What is a command shell and why would I use one? -- How can I move around on my computer? -- How can I see what files and directories I have? -- How can I specify the location of a file or directory on my computer? + - What is a command shell and why would I use one? + - How can I move around on my computer? + - How can I see what files and directories I have? + - How can I specify the location of a file or directory on my computer? -:::::::::::::::::::::::::::::::::::::::::::::::::: **This lesson has been adapted from the original [Data Carpentry - Shell Genomics](https://datacarpentry.org/shell-genomics/) to be run using the NeSI infrastructure as part of the Otago Bioinformatics Spring School instead of AWS.** @@ -65,34 +59,6 @@ We will learn the basics of the shell by manipulating some data files. Some of t We will also be using several bioinformatic packages in later lessons and installing all of the software would take up time even more time. A 'ready-to-go' server lets us focus on learning. -## How to access the remote server - -During this workshop we will be running the material on the NeSI platform, using the Jupyter interface, however it is -also possible to run this material locally on your own machine. - -One of the differences between running on NeSI or your own machine is that on NeSI we preinstall popular software and make it available to our users, whereas on your own machine you need to install the software yourself (e.g. using a package manager such as conda). - -### Connect to Jupyter on NeSI - -1. Connect to [https://jupyter.nesi.org.nz](https://jupyter.nesi.org.nz) -2.

Enter NeSI username, HPC password and 6 digit second factor token (as set on MyNeSI)
![image](fig/nesi_images/Login_jupyterhubNeSI.png)

-3.

Choose server options as below -
make sure to choose the correct project code `nesi02659`, number of CPUs **4**, memory **4GB** prior to pressing the Start button. - -
![image](fig/nesi_images/ServerOptions_jupyterhubNeSI.png){width="700"} - -4.

Start a terminal session from the JupyterLab launcher
![image](fig/nesi_images/ga-vl01jupyterhubNeSI.png){width="500"} - -::::::::::::::::::::::::::::::::::::::::: callout - -You can log-in to the remote server using the [instructions from the Introduction to Cloud Computing for Genomics lesson](https://datacarpentry.org/cloud-genomics/02-logging-onto-cloud#logging-onto-a-cloud-instance). -Your instructor will supply to you the `ip_address` and password that you need to login. - -Each of you will have a different `ip_address`. This will -prevent us from accidentally changing each other's files as we work through the -exercises. The password will be the same for everyone. - -After logging in, you will see a screen showing something like this: ```output Welcome to Ubuntu 20.04.5 LTS (GNU/Linux 5.4.0-137-generic x86_64) diff --git a/docs/02-the-filesystem.md b/docs/02-the-filesystem.md index 8d71234..53431f0 100644 --- a/docs/02-the-filesystem.md +++ b/docs/02-the-filesystem.md @@ -1,25 +1,19 @@ ---- -title: Navigating Files and Directories -teaching: 30 -exercises: 20 ---- +# 2. Navigating Files and Directories -::::::::::::::::::::::::::::::::::::::: objectives +!!! clipboard-list "Lesson objectives" -- Use a single command to navigate multiple steps in your directory structure, including moving backwards (one level up). -- Perform operations on files in directories outside your working directory. -- Work with hidden directories and hidden files. -- Interconvert between absolute and relative paths. -- Employ navigational shortcuts to move around your file system. + - Use a single command to navigate multiple steps in your directory structure, including moving backwards (one level up). + - Perform operations on files in directories outside your working directory. + - Work with hidden directories and hidden files. + - Interconvert between absolute and relative paths. + - Employ navigational shortcuts to move around your file system. -:::::::::::::::::::::::::::::::::::::::::::::::::: - -:::::::::::::::::::::::::::::::::::::::: questions +!!! clipboard-question "questions" -- How can I perform operations on files outside of my working directory? -- What are some navigational shortcuts I can use to make my work more efficient? + - How can I perform operations on files outside of my working directory? + - What are some navigational shortcuts I can use to make my work more efficient? + -:::::::::::::::::::::::::::::::::::::::::::::::::: ## Moving around the file system diff --git a/docs/03-working-with-files.md b/docs/03-working-with-files.md index 6b15fb0..5d62d29 100644 --- a/docs/03-working-with-files.md +++ b/docs/03-working-with-files.md @@ -1,24 +1,19 @@ ---- -title: Working with Files and Directories -teaching: 30 -exercises: 15 ---- +# 3. Working with Files and Directories -::::::::::::::::::::::::::::::::::::::: objectives -- View, search within, copy, move, and rename files. Create new directories. -- Use wildcards (`*`) to perform operations on multiple files. -- Make a file read only. -- Use the `history` command to view and repeat recently used commands. +!!! clipboard-list "Lesson objectives" -:::::::::::::::::::::::::::::::::::::::::::::::::: + - View, search within, copy, move, and rename files. Create new directories. + - Use wildcards (`*`) to perform operations on multiple files. + - Make a file read only. + - Use the `history` command to view and repeat recently used commands. -:::::::::::::::::::::::::::::::::::::::: questions +!!! clipboard-question "questions" -- How can I view and search file contents? -- How can I create, copy and delete files and directories? -- How can I control who has permission to modify a file? -- How can I repeat recently used commands? + - How can I view and search file contents? + - How can I create, copy and delete files and directories? + - How can I control who has permission to modify a file? + - How can I repeat recently used commands? :::::::::::::::::::::::::::::::::::::::::::::::::: diff --git a/docs/04-redirection.md b/docs/04-redirection.md index 90800a5..5a24a0c 100644 --- a/docs/04-redirection.md +++ b/docs/04-redirection.md @@ -1,22 +1,17 @@ ---- -title: Redirection -teaching: 30 -exercises: 15 ---- +# 4. Redirection -::::::::::::::::::::::::::::::::::::::: objectives -- Employ the `grep` command to search for information within files. -- Print the results of a command to a file. -- Construct command pipelines with two or more stages. -- Use `for` loops to run the same command for several input files. +!!! clipboard-list "Lesson Objectives" -:::::::::::::::::::::::::::::::::::::::::::::::::: + - Employ the `grep` command to search for information within files. + - Print the results of a command to a file. + - Construct command pipelines with two or more stages. + - Use `for` loops to run the same command for several input files. -:::::::::::::::::::::::::::::::::::::::: questions +!!! clipboard-question "questions" -- How can I search within files? -- How can I combine existing commands to do new things? + - How can I search within files? + - How can I combine existing commands to do new things? :::::::::::::::::::::::::::::::::::::::::::::::::: diff --git a/docs/05-writing-scripts.md b/docs/05-writing-scripts.md index ddd3bc9..4ea0ae7 100644 --- a/docs/05-writing-scripts.md +++ b/docs/05-writing-scripts.md @@ -1,23 +1,17 @@ ---- -title: Writing Scripts and Working with Data -teaching: 20 -exercises: 20 ---- +# 5. Writing Scripts and Working with Data -::::::::::::::::::::::::::::::::::::::: objectives -- Use the `nano` text editor to modify text files. -- Write a basic shell script. -- Use the `bash` command to execute a shell script. -- Use `chmod` to make a script an executable program. +!!! clipboard-list "Lesson objectives" -:::::::::::::::::::::::::::::::::::::::::::::::::: + - Use the `nano` text editor to modify text files. + - Write a basic shell script. + - Use the `bash` command to execute a shell script. + - Use `chmod` to make a script an executable program. -:::::::::::::::::::::::::::::::::::::::: questions +!!! clipboard-question "questions" -- How can we automate a commonly used set of commands? + - How can we automate a commonly used set of commands? -::::::::::::::::::::::::::::::::::::::::::::::::::