You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fixes#726
The existing developer setup guide uses Linux-specific tooling
(apt, pipx, poetry). This adds a dedicated macOS section covering
Miniconda installation, Python version requirements, pip-based
dev install, Google Cloud CLI setup via brew, and VS Code
terminal integration.
Copy file name to clipboardExpand all lines: README.md
+62Lines changed: 62 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,6 +46,8 @@ for release notes.
46
46
47
47
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.
48
48
49
+
> **macOS users:** See the [macOS setup section](#developer-setup-macos) below.
50
+
49
51
Fork and clone this repo:
50
52
51
53
```bash
@@ -129,6 +131,66 @@ Tests will run slowly the first time, as data required for testing
129
131
will be read from GCS. Subsequent runs will be faster as data will be
130
132
cached locally in the "gcs_cache" folder.
131
133
134
+
## Developer setup (macOS)
135
+
136
+
The instructions above are Linux-focused. If you are on macOS, follow these steps instead.
137
+
138
+
### Install Miniconda
139
+
140
+
Download and install Miniconda for macOS from https://docs.conda.io/en/latest/miniconda.html.
141
+
Choose the Apple Silicon installer if you have an M1/M2/M3 chip, or the Intel installer otherwise. You can check with:
142
+
```bash
143
+
uname -m
144
+
# arm64 = Apple Silicon, x86_64 = Intel
145
+
```
146
+
147
+
After installation, close and reopen your terminal for conda to be available.
148
+
149
+
### Create a conda environment
150
+
151
+
The package requires Python >=3.10 and <3.13. Python 3.13+ is not currently supported.
To run legacy tests or access data from GCS, install the Google Cloud CLI:
177
+
```bash
178
+
brew install google-cloud-sdk
179
+
```
180
+
181
+
Then authenticate:
182
+
```bash
183
+
gcloud auth application-default login
184
+
```
185
+
186
+
This opens a browser — log in with any Google account. You will also need to [request access to MalariaGEN data on GCS](https://malariagen.github.io/vector-data/vobs/vobs-data-access.html).
187
+
188
+
### VS Code terminal integration
189
+
190
+
To use the `code` command from the terminal:
191
+
192
+
Open VS Code → `Cmd + Shift + P` → type `Shell Command: Install 'code' command in PATH` → press Enter.
193
+
132
194
## Release process
133
195
134
196
Create a new GitHub release. That's it. This will automatically
0 commit comments