Skip to content

Commit

Permalink
add note on installing on mac silicon. see #198 for full conversation (
Browse files Browse the repository at this point in the history
  • Loading branch information
aaraney committed Jun 8, 2023
1 parent 0e8c85c commit d542128
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions python/caches/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@ $ python3 -m pip install --upgrade pip
$ python3 -m pip install hydrotools.caches
```

### Mac Silicon Note

If you experience issues installing the `tables` library while installing
`hydrotools.caches`, you likely need to install `HDF5` and/or set the `HDF5_DIR`
environement variable prior to installation. Brew users should install
`HDF5` using `brew install hdf5` and try reinstalling `hydrotools.caches` using
`env HDF5_DIR=$(brew --prefix hdf5) pip install hydrotools.caches`. If you've
already installed `HDF5` via brew, ignore the first step.

## Usage

The following example demonstrates how one might use `hydrotools.caches.hdf` to cache a `pandas.dataframe` generated by a long running process.
Expand Down

0 comments on commit d542128

Please sign in to comment.