ndarray-npy

Build status Coverage Dependencies status Crate Documentation Chat

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 fixed-size integer, floating point, and bool 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:

Using with Cargo

To use with the default features:

toml [dependencies] ndarray-npy = "0.6"

The default feature set includes the compressed_npz feature, which enables support for uncompresssed and compressed .npz files. This requires a dependency on the [zip crate] and a compression backend crate.

To use without the default features:

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

With default-features = false, ndarray-npy provides support only for .npy files, not .npz files. If you want .npz file support, you can select additional features:

For example, you can use just the npz feature:

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

Library authors

Library authors should specify their dependency on ndarray-npy like this:

toml [dependencies.ndarray-npy] version = "0.6" default-features = false features = [FEATURES_LIST_HERE]

where the features list is one of the following:

Releases

Contributing

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

License

Copyright 2018–2020 Jim Turner and ndarray-npy developers

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.