Skip to content

Commit 5186eda

Browse files
authored
Update README.md
1 parent 82f2a09 commit 5186eda

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@ In Vscode, you can now open a rendered version of this readme. Right-click the f
2525
2626
### Task 2: Downloading and installing Miniconda.
2727
To develop and execute our python code, we use a python container software called miniconda. Using miniconda you can create an `environment` which holds python and all the required software to run the given scripts.
28-
- Navigate to https://docs.conda.io/en/latest/miniconda.html in your favorite browser.
28+
- Navigate to https://docs.conda.io/en/latest/miniconda.html in your favourite browser.
2929
The HRZ-Pool computers run Ubuntu Linux. Download the `Miniconda3 Linux 64-bit` file.
3030
3131
- Open the terminal on your machine by pressing `Ctrl+Alt+T`. Navigate into the Downloads folder by typing `cd Downloads`. Before running the installer, set the executable bit by typing `chmod +x Miniconda3-latest-Linux-x86_64.sh`. Install Miniconda via `./Miniconda3-latest-Linux-x86_64.sh`.
32-
- Finally execute this command `source ~/.bashrc`. Check if you can see the `(base)` environment name on the left hand side of your command line. This means that (mini)conda is installed correctly.
32+
- Finally, execute this command `source ~/.bashrc`. Check if you can see the `(base)` environment name on the left-hand side of your command line. This means that (mini)conda is installed correctly.
3333
3434
35-
### Task 3: Setting up Vscode for python development
35+
### Task 3: Setting up Vscode for Python development
3636
- Open Visual Studio Code (Vscode).
3737
- Click on the extensions tab in Vscode (on the left hand side) or press `Ctrl+Shift+X`. Install the `Python` and `Remote-SSH` extensions. Choose the versions provided by Microsoft.
3838
- Make the Miniconda interpreter your default in Vscode by pressing `Ctrl+Shift+P`. Type `select interpreter` and press enter. In the following dialogue, choose the `base` environment.
@@ -44,24 +44,24 @@ The HRZ-Pool computers run Ubuntu Linux. Download the `Miniconda3 Linux 64-bit`
4444
```bash
4545
pip install -r requirements.txt
4646
```
47-
to install the python packages required for this exercise.
47+
to install the Python packages required for this exercise.
4848
4949
### Task 5: Test your code.
50-
Scientific software must provide reproducible results, and Automatic testing ensures that our software runs reliably. For example, the recent [CrowdStrike incident](https://en.wikipedia.org/wiki/2024_CrowdStrike_incident), which won the 2024 '[Most Epic Fail](https://uk.pcmag.com/security/153845/crowdstrike-exec-shows-up-to-accept-most-epic-fail-award-in-person)' award highlights the importance of thorough testing.
50+
Scientific software must provide reproducible results, and automatic testing ensures that our software runs reliably. For example, the recent [CrowdStrike incident](https://en.wikipedia.org/wiki/2024_CrowdStrike_incident), which won the 2024 '[Most Epic Fail](https://uk.pcmag.com/security/153845/crowdstrike-exec-shows-up-to-accept-most-epic-fail-award-in-person)' award highlights the importance of thorough testing.
5151
5252
![dont_be_vincent](./images/vincent.png)
5353
5454
To prevent similar issues, we strongly recommend testing your code. Let's learn a lesson from the humorous Vincent in the image above! We suggest using [Nox](https://nox.thea.codes/en/stable/) for test automation.
5555
56-
- To run some of the tests we prepared for you type,
56+
- To run some of the tests we prepared for you type
5757
```bash
5858
nox -s test
5959
```
6060
The python extension provides test integration into Vscode. To use it, click on the lab-flask icon on the left sidebar. When opening it for the first time, it asks you for a configuration.
6161
Click the `Configure Python Tests` button and select `pytest` in the ensuing prompt. In the next step, Vscode wants to know the location of the test folder. Choose `tests`.
6262
Vscode will now display your tests on the sidebar on the left. Click the play symbol next to the tests folder to run all tests.
6363
64-
### Task 6: Implement and test a python class.
64+
### Task 6: Implement and test a Python class.
6565
- Open `src/my_code.py` and finish the `__init__` function of the `Complex` class. The idea here is to implement support for complex numbers (see: https://en.wikipedia.org/wiki/Complex_number for more information about complex numbers). Double-check your code by running `nox -s test`.
6666
6767
### Task 7: Breakpoints
@@ -76,7 +76,7 @@ To prevent similar issues, we strongly recommend testing your code. Let's learn
7676
7777
7878
### Task 10: Getting nox to help you format your code.
79-
- Professionally written python code respects coding conventions. Type `nox -s format` to have `nox` format your code for you.
79+
- Professionally written Python code respects coding conventions. Type `nox -s format` to have `nox` format your code for you.
8080
8181
### Optional Task 11: Linting
8282
- `nox` can do even more for you! A basic syntax error at the wrong place can cost days of computation time. Type
@@ -92,7 +92,7 @@ To prevent similar issues, we strongly recommend testing your code. Let's learn
9292
```
9393
9494
### Final Task 13: Finishing up the task
95-
At the end of the day after you finished all your tasks we want to save the results and upload them to your online github repository. Ideally, all the tests were successful. Follow these steps:
95+
At the end of the day after you finished all your tasks we want to save the results and upload them to your online GitHub repository. Ideally, all the tests were successful. Follow these steps:
9696
- Open a terminal by pressing `Ctrl+Alt+T`. Navigate into this directory using the `cd` command.
9797
- Use
9898
```bash
@@ -113,7 +113,7 @@ At the end of the day after you finished all your tasks we want to save the resu
113113
git commit -m "put_your_commit_message_here"
114114
```
115115
and use your own commit message to describe the commit.
116-
- Finally, push everything to github with
116+
- Finally, push everything to GitHub with
117117
```bash
118118
git push
119119
```

0 commit comments

Comments
 (0)