Skip to content

Update beginners #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 43 commits into from
Apr 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
f01a313
Replace jupyter notebooks by markdown files
AnnikaLau Mar 11, 2025
a34566c
Change all files into markdown files
AnnikaLau Mar 11, 2025
92bd6f9
Remove JupyterLab from README
AnnikaLau Mar 13, 2025
9224061
Fix last commit
AnnikaLau Mar 13, 2025
318569d
Update exercise 1 to use with markdown only
AnnikaLau Mar 25, 2025
152bce8
Rename exercise file
AnnikaLau Mar 25, 2025
ebfd547
Fix initialization instructions
AnnikaLau Mar 25, 2025
d6c04a0
Update Exercise_2
AnnikaLau Mar 25, 2025
583a959
Rename exercise
AnnikaLau Mar 25, 2025
1da3af1
Improve helpers function
AnnikaLau Mar 25, 2025
95bd991
Update exercise 3
AnnikaLau Mar 25, 2025
903c46d
Rename exercise 3
AnnikaLau Mar 25, 2025
585e647
Update exercise 4
AnnikaLau Mar 26, 2025
307eedc
Rename exercise 4
AnnikaLau Mar 26, 2025
5036ea2
Update exercise 5
AnnikaLau Mar 27, 2025
09970b3
Rename exercise 5
AnnikaLau Mar 27, 2025
42a20a4
Update exercise 6
AnnikaLau Mar 31, 2025
25cb4c0
Rename exercise 6
AnnikaLau Mar 31, 2025
303df5e
Update exercise 7
AnnikaLau Mar 31, 2025
61b90ee
Rename exercise 7
AnnikaLau Mar 31, 2025
2b97577
Remove remark about jupyter notebook
AnnikaLau Mar 31, 2025
f986827
Small fixes
AnnikaLau Mar 31, 2025
e3d5823
Use log file from check_requirements.sh to demonstrate how .gitignore
AnnikaLau Mar 31, 2025
fb71656
Delete conference_planning folder every time when initialising a new one
AnnikaLau Apr 1, 2025
4a6f8d9
Remark that users should use their actual name
AnnikaLau Apr 1, 2025
45539e0
Fix Git version check for very old version
AnnikaLau Apr 1, 2025
e311a59
Update README
mjaehn Apr 1, 2025
a7da53c
Add logfile to gitignore
mjaehn Apr 1, 2025
0df2e5e
Revise Ex. 1 (and helpers.sh)
mjaehn Apr 1, 2025
3756cd4
Remove notebook from restart instructions
mjaehn Apr 1, 2025
9a70161
Further replacements for optional info
mjaehn Apr 1, 2025
1954321
Remove check for bash kernel
mjaehn Apr 1, 2025
6291839
Ex. 2: Refer to Ex. 1 for Initialization
mjaehn Apr 1, 2025
2d8a690
Ex. 1+2: Remove underscore
mjaehn Apr 1, 2025
b5636d9
Link to Initialization for all Exercises
mjaehn Apr 1, 2025
827d90a
Formatting inline code
mjaehn Apr 1, 2025
6f92cf4
Review Ex. 2
mjaehn Apr 1, 2025
af3394a
Remove references to Jupyter notebooks
mjaehn Apr 1, 2025
8232d99
Fix token link
mjaehn Apr 1, 2025
03b8f45
Fix link in README
AnnikaLau Apr 1, 2025
786a27b
Fix set up instructions
AnnikaLau Apr 1, 2025
8afb359
Change wording for required Unix commands
AnnikaLau Apr 1, 2025
a9d7c53
Remove log file from .gitignore
AnnikaLau Apr 1, 2025
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
81 changes: 8 additions & 73 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ To run this course on your computer, the following things need to be set up:
1. [Git](#1-installing-git-on-your-computer)
2. [SSH key linked to your GitHub account](#2-creating-a-github-account-and-ssh-key)
3. [Python](#3-installing-python)
4. [JupyterLab](#4-installing-jupyterlab-beginners-course-only) (Beginner's course only)
5. [Final check](#5-final-check-advanced-course-only) (Advanced course only)
4. [Final check](#4-final-check)


### 1. Installing Git on your Computer
Expand Down Expand Up @@ -51,92 +50,28 @@ Having a GitHub account allows you to collaborate on open-source projects and st
#### Instructions

- [Create your own GitHub account](https://github.com/) (if not yet available)
- [Generate an SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).
- [Add your SSH key to GitHub](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account).

- [Generate an SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
- [Add your SSH key to GitHub](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account)

### 3. Installing Python

To install Python, we recommend the [instructions from Real Python](https://realpython.com/installing-python/),
but of course many other instructions will do as well.

### 4. Installing JupyterLab (Beginner's Course only)

For the beginners course, you also need some non-standard Python packages, namely:
- jupyterlab
- bash_kernel

To install these two packages, run the following commands in your terminal.

If you have set up your SSH key, clone this Git repository by using the SSH protocol:
```bash
git clone [email protected]:C2SM/git-course.git
```

Otherwise, use the HTTPS protocol:
```bash
git clone https://github.com/C2SM/git-course.git
```

Navigate into the cloned repository:
```bash
cd git-course
```

Create a new Python virtual environment named *git-course_env*:
```bash
python -m venv git-course_env
```

Activate the newly created virtual environment:
```bash
source git-course_env/bin/activate
```

Install the required Python packages specified in the *requirements.txt* file:
```bash
pip install -r requirements.txt
```

Install Bash kernel for Jupyter notebooks:
```bash
python -m bash_kernel.install
```

To be able to access directories outside of the *git-course* repository in JupyterLab, you need to navigate out of the repository BEFORE launching JupyterLab:
```
cd ..
```

Finally, you can start with the exercises by running:
```
jupyter lab
```
This command will open the JupyterLab interface in your browser.
If it does not open automatically, you will need to copy and paste the URL manually.
In this case, please follow the instructions on your terminal.

If you are not able to start JupyterLab for some reason, you can try to launch a Jupyter Notebook, which provides a simpler user interface:
```
jupyter notebook
```

### 5. Final check (Advanced course only)
### 4. Final check
Check if everything is set up correctly by following the steps below from a Linux shell.

- Step 1: Download the file [check_requirements_advanced.sh](https://github.com/C2SM/git-course/blob/main/check_requirements_advanced.sh).
- Step 1: Download the file [check_requirements.sh](https://github.com/C2SM/git-course/blob/main/check_requirements.sh).
```
curl -O https://raw.githubusercontent.com/C2SM/git-course/main/check_requirements_advanced.sh
curl -O https://raw.githubusercontent.com/C2SM/git-course/main/check_requirements.sh
```
- Step 2: Make the file executable.
```
chmod +x ./check_requirements_advanced.sh
chmod +x ./check_requirements.sh
```
- Step 3: Run the script from a Linux shell.
```
./check_requirements_advanced.sh
./check_requirements.sh
```


**Have fun!**

Loading