ndarray-npy 0.1.1

.npy and .npz file format support for ndarray
Documentation

ndarray-npy

Build status Dependencies status Crate Documentation

This crate provides support for reading/writing ndarray's ArrayBase type from/to .npy and .npz files. See the documentation for more information.

This crate is a work-in-progress. It currently supports only a subset of .npy header descriptors and supports only primitive numeric types as the array element type. You can implement ReadableElement and WritableElement for your own types, but the next breaking release of this library will probably change those traits.

Future plans include support for:

  • Memory-mapped files.
  • More element types (e.g. structs). If you need support for structs before this is implemented in ndarray-npy, check out the npy crate.
  • Possibly merging this with the npy crate.

Using with Cargo

To use with the default features:

[dependencies]
ndarray-npy = "0.1"

To use without the default features:

[dependencies]
ndarray-npy = { version = "0.1", default-features = false }

There are two optional features that are enabled by default:

  • npz enables support for .npz files, which requires a dependency on the zip crate.
  • compressed_npz enables support for compressed .npz files, which requires a dependency on the zip crate and also pulls in the necessary dependencies for the zip crate's deflate feature.

For example, you can use just the npz feature:

[dependencies.ndarray-npy]
version = "0.1"
default-features = false
features = ["npz"]

Releases

  • 0.1.1

    • Improved crate documentation (no functional changes).

  • 0.1.0

    • Initial release.

Contributing

Please feel free to create issues and submit PRs. PRs adding more tests would be especially appreciated.

License

Copyright 2018 Jim Turner

Licensed under the Apache License, Version 2.0 or the MIT license, at your option. You may not use this project except in compliance with those terms.