Skip to content

Commit

Permalink
docs: point to new hdf5-rust fork with example patch section
Browse files Browse the repository at this point in the history
  • Loading branch information
gauteh committed Oct 7, 2023
1 parent 9f26ddc commit a6b2568
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,18 @@
//!
//! ## Fast indexing
//!
//! The indexing can be sped up considerably (_about 200x_) by adding a new interface to iterating
//! over chunks in HDF5. The `fast-index` feature flag currently requires a patched version of
//! [hdf5-rust](https://github.com/gauteh/hdf5-rust/tree/hidefix) and
//! [hdf5](https://github.com/gauteh/hdf5/tree/chunk-iter-1-12). See this upstream
//! [pull-request](https://github.com/HDFGroup/hdf5/pull/6). You therefore have to use `patch` to
//! point the `hdf5` and `hdf5-sys` dependencies to the patched versions for now.
//! The indexing can be sped up considerably (_about 200x_) by using the new interface to [iterating
//! over chunks](https://github.com/HDFGroup/hdf5/pull/6) in HDF5. The `fast-index` feature flag currently requires a patched version of
//! [hdf5-rust](https://github.com/magnusuMET/hdf5-rust/tree/hidefix_jul_2023). You therefore have to use `patch` to
//! point the `hdf5` and `hdf5-sys` dependencies to the patched versions for now, in your
//! `Cargo.toml`:
//!
//! ```ignore
//! [patch.crates-io]
//! hdf5 = { git = "https://github.com/magnusuMET/hdf5-rust", branch = "hidefix_jul_2023" }
//! hdf5-sys = { git = "https://github.com/magnusuMET/hdf5-rust", branch = "hidefix_jul_2023" }
//! hdf5-src = { git = "https://github.com/magnusuMET/hdf5-rust", branch = "hidefix_jul_2023" }
//! ```

#![allow(incomplete_features)]
#![recursion_limit = "1024"]
Expand Down

0 comments on commit a6b2568

Please sign in to comment.