Skip to content

Commit 39a9ac6

Browse files
committed
Changed the order of the guide and polished it
1 parent 490a0a6 commit 39a9ac6

1 file changed

Lines changed: 53 additions & 12 deletions

File tree

LINUX_SETUP.md

Lines changed: 53 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,51 @@
11
# Developer setup (Linux)
22

3-
To get setup for development, see [this video if you prefer VS Code](https://youtu.be/zddl3n1DCFM), or [this older video if you prefer PyCharm](https://youtu.be/QniQi-Hoo9A), and the instructions below.
3+
## 1. Install Git
4+
5+
Choose the command for your Linux distribution:
6+
7+
**Ubuntu, Debian, and Mint:**
8+
9+
```bash
10+
sudo apt update
11+
sudo apt install -y git
12+
```
13+
14+
**Fedora:**
15+
16+
```bash
17+
sudo dnf install -y git
18+
```
19+
20+
**Arch Linux:**
421

5-
## 1. Fork and clone this repo
622
```bash
7-
git clone git@github.com:[username]/malariagen-data-python.git
23+
sudo pacman -S sudo
24+
sudo pacman -S git
25+
sudo pacman -S openssh
26+
```
27+
28+
If your Arch install does not have `sudo` configured yet, run the commands above as `root`, then configure `sudo` for your user.
29+
30+
## 2. Fork and clone this repo
31+
32+
After forking the repository on GitHub, clone your fork.
33+
34+
Use SSH if your SSH keys are set up:
35+
36+
```bash
37+
git clone git@github.com:[YOUR_GITHUB_USERNAME]/malariagen-data-python.git
838
cd malariagen-data-python
939
```
1040

11-
## 2. Install pipx
41+
Use HTTPS if you prefer, or if you do not have SSH keys configured (common on WSL):
42+
43+
```bash
44+
git clone https://github.com/[YOUR_GITHUB_USERNAME]/malariagen-data-python.git
45+
cd malariagen-data-python
46+
```
47+
48+
## 3. Install pipx
1249

1350
Choose the command for your Linux distribution:
1451

@@ -23,7 +60,7 @@ pipx ensurepath
2360
**Fedora:**
2461

2562
```bash
26-
sudo dnf install pipx
63+
sudo dnf install -y pipx
2764
pipx ensurepath
2865
```
2966

@@ -34,9 +71,14 @@ sudo pacman -S python-pipx
3471
pipx ensurepath
3572
```
3673

37-
*(Note: You may need to open a new terminal or run `source ~/.profile` to apply PATH changes after this step).*
74+
Close and reopen your terminal to apply PATH changes.
75+
If you prefer to reload the shell in-place, run:
76+
77+
```bash
78+
exec bash
79+
```
3880

39-
## 3. Install Poetry and Python 3.12
81+
## 4. Install Poetry and Python 3.12
4082

4183
The package requires `>=3.10,<3.13`. We use Poetry's built-in installer to handle the Python version universally across all distributions.
4284

@@ -45,15 +87,14 @@ pipx install poetry
4587
poetry python install 3.12
4688
```
4789

48-
## 4. Create and activate development environment
90+
## 5. Create development environment
4991

5092
```bash
5193
poetry env use 3.12
5294
poetry install --extras dev
53-
poetry shell
5495
```
5596

56-
## 5. Install pre-commit hooks
97+
## 6. Install pre-commit hooks
5798

5899
```bash
59100
pipx install pre-commit
@@ -66,15 +107,15 @@ Run pre-commit checks manually:
66107
pre-commit run --all-files
67108
```
68109

69-
## 6. Run tests
110+
## 7. Run tests
70111

71112
Run fast unit tests using simulated data:
72113

73114
```bash
74115
poetry run pytest -v tests/anoph
75116
```
76117

77-
## 7. Google Cloud authentication (for legacy tests)
118+
## 8. Google Cloud authentication (for legacy tests)
78119

79120
To run legacy tests which read data from GCS, you'll need to [request access to MalariaGEN data on GCS](https://malariagen.github.io/vector-data/vobs/vobs-data-access.html).
80121

0 commit comments

Comments
 (0)