index.md 1.3 KB


permalink: /index.html

npy.js

Read .npy files from numpy in Node/JS.

Installation

Include npy.js in your project directly, or:

yarn add npyjs
# npm i npyjs

Usage

  • Create a new npyjs object. javascript import npyjs from "npyjs"; let n = new npyjs();
  • This object can now be used load .npy files. Arrays are returned via a JavaScript callback, so usage looks like this: javascript n.load('my-array.npy', (array, shape) => { // `array` is a one-dimensional array of the raw data // `shape` is a one-dimensional array that holds a numpy-style shape. console.log(`You loaded an array with ${array.length} elements and ${shape.length} dimensions.`); });

You can also use this library promise-style:

n.load("test.npy").then(res => {
    // res has { data, shape, dtype } members.
});

Unless otherwise specified, all code inside of this repository is covered under the license in LICENSE.

Please report bugs or contribute pull-requests on GitHub.


Made with ♥ at JHU APL