Skip to content

Updated the install instructions for Apple Silicon systems #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ronquist wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated the install instructions for Apple Silicon systems #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 11 additions & 45 deletions docs/for-developers/install_apple_silicon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Install Apple's Command Line Tools (if not already installed):
xcode-select --install
```

If they are already installed, a message will inform you about this.

### Homebrew and Required Packages

If you don’t have [Homebrew](https://brew.sh/) installed, install it using:
Expand All @@ -31,50 +33,15 @@ brew upgrade
Next, install the necessary packages:

```bash
brew install gcc opam wget
```

### Set GCC as the Default cc Compiler for OpenBLAS installation
If GCC is not set as your default cc compiler, create a symlink to ensure it's used:

```bash
# Create a symbolic link to use GCC as the default cc compiler
# Note: Adjust the GCC version if different (e.g., gcc-12)
cd $HOMEBREW_PREFIX/bin && ln -s gcc-15 cc
```

Verify: After this, check that cc points to the correct compiler:
```bash
which cc
```
Open a new terminal window for the changes to take effect.


Notes for existing TreePPL users:

- If OpenBLAS was previously installed via Homebrew, uninstall it before continuing:

```bash
brew uninstall openblas
```

### Installing OpenBLAS from Source

Download and install OpenBLAS manually:

```bash
wget https://github.com/OpenMathLib/OpenBLAS/releases/download/v0.3.31/OpenBLAS-0.3.31.zip
unzip OpenBLAS-0.3.31.zip
cd OpenBLAS-0.3.31
make
sudo make install
brew install opam openblas libomp fftw
```
This installs OpenBLAS to `/opt/OpenBLAS`.

### Delete the cc symbolic link
Finally, set some environment variables needed when compiling owl:

```bash
rm $HOMEBREW_PREFIX/bin/cc
export OWL_LDFLAGS="-L/opt/homebrew/opt/libomp/lib -lomp"
export OWL_CPPFLAGS="-Xpreprocessor -fopenmp"
export SDKROOT="/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk"
```


Expand All @@ -89,18 +56,17 @@ opam init --bare
opam update
opam switch create treeppl-ocaml 5.3.0
eval $(opam env --switch=treeppl-ocaml)
export PKG_CONFIG_PATH="/opt/OpenBLAS/lib/pkgconfig:$PKG_CONFIG_PATH"
opam install -y --no-depexts dune ocamlfind linenoise owl menhir
opam install dune ocamlfind linenoise menhir owl
```
If you get an error, try the command above again without the -y option, then continue.

Opam supports multiple OCaml environments via switches. TreePPL expects the *treeppl-ocaml* switch to be active:
Opam supports multiple OCaml environments via switches; the number refers to the OCaml version. TreePPL expects the *treeppl-ocaml* switch to be active:

```bash
eval $(opam env --switch=treeppl-ocaml)
```

To automatically activate it when opening a new shell, add the above line to your `~/.zshrc`.
To automatically activate it when opening a new shell, add the above line to your `~/.zshrc`. We are basing the switch on version 5.3.0 of OCaml as this is the latest version we have tested thoroughly but we are not aware of any issues with more recent versions of OCaml.


### Set Up Environment Variables

Expand Down
Loading