Skip to content

Commit

Permalink
review get started chapters
Browse files Browse the repository at this point in the history
  • Loading branch information
ahasverus committed Jul 25, 2024
1 parent ace1a10 commit 7d06dab
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 22 deletions.
20 changes: 10 additions & 10 deletions chapters/introduction.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Introduction


The FRB-CESAB server **Rossinante** is dedicated to *medium* performance
The FRB-CESAB server **Rossinante** is dedicated to
scientific computing (see @tbl-hardware for hardware specification).
It runs under the GNU/Linux distribution **Debian 12** (Bookworm).

Expand Down Expand Up @@ -47,16 +47,16 @@ that you can launch jobs whenever you want. However you are invited to respect s
You have access to four personal directories:

- `/home/you/`
- `/media/sancho/you` (external drive)
- `/media/seagate/you` (external drive)
- `/media/cervantes/you` (external drive)
- `/media/sancho/you/` (external drive)
- `/media/seagate/you/` (external drive)
- `/media/cervantes/you/` (external drive)

You can create, edit and remove any files/directories you want inside these directories.
You can create, edit, rename and remove any files/directories you want inside these directories.

::: {.callout-important}
## Important

Rossinante is **not a storage server**. The 30 TB of storage are shared
Rossinante is **not a storage server**. The 30 TB storage are shared
among all users. You can store large datasets to run yours
analyses, but once you're done, please remove these files.

Expand All @@ -83,25 +83,25 @@ analyses, but once you're done, please remove these files.
- [`FFmpeg`](https://ffmpeg.org/) -- Transcoding multimedia files
- [`ImageMagick`](https://imagemagick.org) -- Image manipulation program
- [`Poppler`](https://poppler.freedesktop.org/) -- PDF utility library
- [`ExifTool`](https://exiftool.org/) - File metadata utility
- [`ExifTool`](https://exiftool.org/) -- File metadata utility
- [`GDAL`](https://gdal.org/), [`GEOS`](https://trac.osgeo.org/geos), [`PROJ`](https://proj.org/) -- Spatial libraries
- [`htop`](https://htop.dev/) -- CPU, RAM, and processes monitoring tool
- [`ctop`](https://github.com/bcicen/ctop) -- Docker containers monitoring tool
- [`nano`](https://www.nano-editor.org/), [`Vim`](https://www.vim.org/) and [`Neovim`](https://neovim.io/) -- CLI text editors
- [`screen`](https://www.gnu.org/software/screen/) and [`tmux`](https://github.com/tmux/tmux/wiki) -- Terminal multiplexers
- [`tree`](http://mama.indstate.edu/users/ice/tree/) -- Recursive directory listing program
- [`curl`](https://curl.se/) and [`wget`](https://www.gnu.org/software/wget/manual/wget.html) -- Download managers
- [`rsync`](https://rsync.samba.org/) -- Incremental file transfer
- [`zip`](https://linuxize.com/post/how-to-zip-files-and-directories-in-linux/) and [`unzip`](https://linuxize.com/post/how-to-unzip-files-in-linux/) -- ZIP files managers
- [`zsh`](https://www.zsh.org/) -- Unix shell (alternative to Bash)
- [`lazygit`](https://github.com/jesseduffield/lazygit) -- CLI interface for git



## Missing software

If you need to use a non-installed software, please contact the administrator.

Note that each user has a personal R library in which he/she can install every
R packages he/she wants (independently of other users). For Python, packages are
shared among all users (except if you work with virtual environments **[recommended]**).



23 changes: 13 additions & 10 deletions chapters/setup.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ Let's say that:
| `22` | The port of the SSH server |
+---------------------+------------------------------+

**N.B.** You have to replace these values by the ones provided by the administrator.



## SSH connection

Expand All @@ -33,8 +36,8 @@ SSH client[^1]):
- On Windows, open the [Git Bash](https://www.atlassian.com/git/tutorials/git-bash)
app[^2] (installed by default with the [git](https://git-scm.com/) software)

[^1]: On Windows, you don't need anymore to install Putty.
[^2]: Don't use PowerShell or RStudio terminal. They can be unstable. Git Bash
[^1]: On Windows, you don't need to install Putty anymore.
[^2]: Don't use PowerShell or RStudio terminal. Git Bash
allows you to use GNU/Linux commands on Windows.


Expand Down Expand Up @@ -104,7 +107,7 @@ cd ~
# Check if the folder .ssh/ exists ----
ls -al

# Create a new hidden folder (if required) ----
# Create a new hidden folder (if not already existing) ----
mkdir -p ~/.ssh

# Change folder permissions ----
Expand Down Expand Up @@ -281,13 +284,13 @@ If you want to communicate with GitHub through the SSH protocol (recommended)
you need to generate a new SSH keys pair (different from the one used to connect
to Rossinante).

Let's create a new SSH keys pair using the cryptosystem `RSA` and a key size of
``4096`` bits. But this time, this SSH keys pair will be generated **on Rossinante**.
Let's create a new SSH keys pair using the cryptosystem `ed25519`. But this time,
this SSH keys pair will be generated **on Rossinante**.


```bash
# Create a new SSH key pair (on Rossinante) ----
ssh-keygen -f ~/.ssh/id_rsa -t rsa -b 4096 -C "[email protected]"
ssh-keygen -f ~/.ssh/id_ed25519 -t ed25519 -C "[email protected]"
```


Expand All @@ -296,7 +299,7 @@ This new SSH keys pair has been stored in `~/.ssh/`.
```bash
# Content of the ~/.ssh folder ----
ls ~/.ssh
## authorized_keys id_rsa id_rsa.pub
## authorized_keys id_ed25519 id_ed25519.pub
```


Expand All @@ -305,7 +308,7 @@ Let's restrict the access to the private key.
```bash
# Change private key permissions ----
# (only jdoe can only read this file)
chmod 400 ~/.ssh/id_rsa
chmod 400 ~/.ssh/id_ed25519
```


Expand All @@ -319,7 +322,7 @@ On Rossinante, print the **public** SSH key:

```bash
# Print the public SSH key ----
cat ~/.ssh/id_rsa.pub
cat ~/.ssh/id_ed25519.pub
```


Expand All @@ -328,7 +331,7 @@ new SSH key (for example *Rossinante key*) and paste your public SSH key.
Click on **Add SSH key**.


Congratulation! You can know communicate with GitHub using the SSH protocol from Rossinante.
**Congratulations!** You can know communicate with GitHub using the SSH protocol from Rossinante.
Let's test the SSH connection between Rossinante and GitHub:

```bash
Expand Down
3 changes: 1 addition & 2 deletions index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@

# Welcome {.unnumbered}

The purpose of this book is to show how to use the FRB-CESAB server **Rossinante**, dedicated to *medium* performance scientific computing.

The purpose of this book is to show how to use the FRB-CESAB server **Rossinante**, dedicated to scientific computing.

0 comments on commit 7d06dab

Please sign in to comment.