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

Jump to bottom

docs: point to new hdf5-rust fork with example patch section #34

Merged
merged 1 commit into from
Oct 15, 2023
Merged

docs: point to new hdf5-rust fork with example patch section #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 12 additions & 6 deletions src/lib.rs
View file
Open in desktop
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
Loading