Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hollandjg authored Dec 15, 2023
1 parent 67846f0 commit 99473c4
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
Prerequisites:
- A POSIX-compatible system (Linux or macOS)
- Python 3.9 (run `python --version` to check that your version of python is correct)
- MPI (e.g. from `brew install open-mpi`)
- MPI (e.g. from `brew install open-mpi` on macOS)
- HDF5 (e.g. from `brew install hdf5` on macOS)

> [!IMPORTANT]
> Windows is not supported for development work – use [WSL](https://learn.microsoft.com/en-us/windows/wsl/) on Windows hosts
Expand All @@ -31,6 +32,18 @@ Installation:
```shell
pip install --upgrade --editable ".[dev]"
```
> You may need to set the value of the `HDF5_DIR` environment variable to install some of the dependencies, especially when installing on macOS. For Apple Silicon (M-Series) CPUs:
> ```shell
> export HDF5_DIR="/opt/homebrew/opt/hdf5"
> pip install --upgrade --editable ".[dev]"
> ```
>
> For Intel CPUs:
> ```shell
> export HDF5_DIR="/usr/local/opt/hdf5"
> pip install --upgrade --editable ".[dev]"
> ```

- Check the module `icesat2_tracks` is available by loading the module:
```shell
python -c "import icesat2_tracks; print(icesat2_tracks.__version__)"
Expand Down

0 comments on commit 99473c4

Please sign in to comment.