Skip to content

Commit 8d7d754

Browse files
committed
docs: add macOS developer setup guide
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.
1 parent bef737a commit 8d7d754

1 file changed

Lines changed: 62 additions & 0 deletions

File tree

README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ for release notes.
4646

4747
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.
4848

49+
> **macOS users:** See the [macOS setup section](#developer-setup-macos) below.
50+
4951
Fork and clone this repo:
5052

5153
```bash
@@ -129,6 +131,66 @@ Tests will run slowly the first time, as data required for testing
129131
will be read from GCS. Subsequent runs will be faster as data will be
130132
cached locally in the "gcs_cache" folder.
131133

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.
152+
```bash
153+
conda create -n malariagen python=3.11
154+
conda activate malariagen
155+
```
156+
157+
### Fork, clone and install
158+
```bash
159+
git clone https://github.com/[username]/malariagen-data-python.git
160+
cd malariagen-data-python
161+
pip install -e ".[dev]"
162+
```
163+
164+
### Install pre-commit hooks
165+
```bash
166+
pre-commit install
167+
```
168+
169+
### Run fast unit tests
170+
```bash
171+
pytest -v tests/anoph
172+
```
173+
174+
### Google Cloud authentication
175+
176+
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+
132194
## Release process
133195

134196
Create a new GitHub release. That's it. This will automatically

0 commit comments

Comments
 (0)