Skip to content

Commit 772d2d9

Browse files
committed
[GSoC] Update Microtask 2 report with improved documentation
Signed-off-by: Xiaoha <[email protected]>
1 parent f6653ae commit 772d2d9

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

gsoc/microtasks/INSTALL_ISSUES_MAC_M1.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11

2-
# 🛠 Microtask 2: Installation Issues Encountered on macOS 14.4 (M1)
2+
# Microtask 2: Installation Issues Encountered on macOS 14.4 (M1)
33

44
This document outlines the issues I encountered while installing [CHAOSS Augur](https://github.com/chaoss/augur) on a **macOS 14.4 M1** machine using **Python 3.9.18** and **Augur v0.86.0**, along with the solutions I applied to resolve them.
55

66
---
77

8-
### ❗️Issue 1: pyenv under Rosetta 2
8+
### Issue 1: pyenv under Rosetta 2
99
**Problem:**
1010
Using `pyenv` to install Python 3.8.x failed due to Rosetta architecture issues:
1111
```
@@ -27,7 +27,7 @@ arch -arm64 pyenv install 3.8.17
2727

2828
---
2929

30-
### ❗️Issue 2: Python 3.8 not compatible with macOS 14
30+
### Issue 2: Python 3.8 not compatible with macOS 14
3131
**Problem:**
3232
Even after installing Python 3.8, some packages like `numpy==1.26.0` and `tensorflow` failed to compile or install properly.
3333

@@ -40,7 +40,7 @@ pyenv global 3.9.18
4040

4141
---
4242

43-
### ❗️Issue 3: `make install-dev` does not exist
43+
### Issue 3: `make install-dev` does not exist
4444
**Problem:**
4545
The official documentation suggests:
4646
```bash
@@ -56,7 +56,7 @@ make install
5656

5757
---
5858

59-
### ❗️Issue 4: `.git-credentials` permission error
59+
### Issue 4: `.git-credentials` permission error
6060
**Problem:**
6161
During configuration, Augur attempts to create `.git-credentials` in `/`, which fails:
6262
```
@@ -75,7 +75,7 @@ Facade worker directory: /Users/<yourname>/augur/repos
7575

7676
---
7777

78-
### ❗️Issue 5: `h5py` version conflict with TensorFlow
78+
### Issue 5: `h5py` version conflict with TensorFlow
7979
**Problem:**
8080
`augur` installs `h5py==3.10.0` but `tensorflow>=2.19.0` requires `h5py>=3.11.0`:
8181
```
@@ -87,11 +87,11 @@ Manually install the required version:
8787
```bash
8888
pip install 'h5py>=3.11.0'
8989
```
90-
⚠️ Warning: This conflicts with Augur’s `setup.py`. It may be necessary to fork and patch `requirements.txt`.
90+
Warning: This conflicts with Augur’s `setup.py`. It may be necessary to fork and patch `requirements.txt`.
9191

9292
---
9393

94-
### ❗️Issue 6: Invalid CLI commands in docs (`augur db init`)
94+
### Issue 6: Invalid CLI commands in docs (`augur db init`)
9595
**Problem:**
9696
Documentation suggests running:
9797
```bash
@@ -112,7 +112,7 @@ augur db upgrade-db-version # to apply migrations
112112

113113
---
114114

115-
### ❗️Issue 7: NLTK download prompt
115+
### Issue 7: NLTK download prompt
116116
**Problem:**
117117
During installation, Augur prompts:
118118
```
@@ -128,7 +128,7 @@ nltk.download('all')
128128

129129
---
130130

131-
## Summary
131+
## Summary
132132

133133
These issues are frequently encountered during Augur installation on Apple Silicon Macs. Resolving and documenting them helps improve onboarding and reduces developer friction.
134134

0 commit comments

Comments
 (0)