Skip to content

Commit

Permalink
Clarify installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
sfiligoi committed Dec 19, 2024
1 parent 67d3bb5 commit 70d3c53
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ An example of installing UniFrac, and using it with CPUs as well as GPUs, can be

## Install (bioconda)

The binaries can be installed via a combination of `conda-forge` and `bioconda`:
The binaries can be installed through [conda](https://docs.anaconda.com/miniconda/)
via a combination of `conda-forge` and `bioconda` repositories:

```
conda create --name unifrac -c conda-forge -c bioconda unifrac-binaries
Expand All @@ -52,20 +53,18 @@ conda activate unifrac

## Install (native)

To install, first the binary needs to be compiled. This assumes that the HDF5
toolchain and libraries are available. More information about how to setup the
stack can be found [here](https://support.hdfgroup.org/HDF5/Tutor/compile.html).
To install, first the binary needs to be compiled. This assumes that the HDF5 toolchain and libraries are available.

Assuming `h5c++` is in your path, the following should work:

```
make api && make main
make clean && make api && make main
#optionally
make install
```


**Note**: if you are using `conda` we recommend installing HDF5 and related compiler using the
**Note**: if you are using [conda](https://docs.anaconda.com/miniconda/) we recommend installing HDF5 and related compiler using the
`conda-forge` channel, for example (on Linux):

```
Expand All @@ -80,6 +79,10 @@ scripts/install_hpc_sdk.sh
source setup_nv_h5.sh
```

If you prefer to build your HDF5 toolchain yourself,
more information about how to setup the
stack can be found [here](https://support.hdfgroup.org/HDF5/Tutor/compile.html).

# Environment considerations

## Multi-core support
Expand Down

0 comments on commit 70d3c53

Please sign in to comment.