Skip to content
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

add some instructions for HDF5-dependency #49

Merged
merged 2 commits into from
Jan 11, 2024
+16 −1
Merged

add some instructions for HDF5-dependency #49

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99473c4
Update README.md
hollandjg Dec 15, 2023
652da69
Update README.md
hollandjg Jan 11, 2024
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
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
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)
hollandjg marked this conversation as resolved.
Show resolved Hide resolved

> [!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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> 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:
> 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:

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this suggestion, Carlos! I've included it in the updated version.

> ```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