https://github.com/aplbrain/npyjs

Read numpy .npy files in JavaScript
https://github.com/aplbrain/npyjs

3d javascript jhuapl nodejs npy npy-files numpy

Last synced: 6 days ago
JSON representation

Read numpy .npy files in JavaScript

• Host: GitHub
• URL: https://github.com/aplbrain/npyjs
• Owner: aplbrain
• License: apache-2.0
• Created: 2016-09-16T15:09:20.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-07-02T20:35:09.000Z (6 months ago)
• Last Synced: 2024-12-04T07:10:34.932Z (19 days ago)
• Topics: 3d, javascript, jhuapl, nodejs, npy, npy-files, numpy
• Language: JavaScript
• Homepage: https://aplbrain.github.io/npyjs/
• Size: 15.1 MB
• Stars: 78
• Watchers: 9
• Forks: 21
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
npy.js

Read .npy files directly in JS




    

    

    

    



## Installation

Include npy.js in your project directly, or:

```shell

yarn add npyjs

# npm i npyjs

```

## Import 

```javascript

import npyjs from "npyjs";

```

## Usage

-   Create a new npyjs object.

```javascript

let n = new npyjs();

```

-   This object can now be used load .npy files. Arrays can be 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 using either .then or async await:

```javascript

n.load("test.npy").then((res) => {

    // res has { data, shape, dtype } members.

});

```

```javascript

const npyArray = await n.load("test.npy");

```

## Accessing multidimensional array elements

-   You can conveniently access multidimensional array elements using the 'ndarray' library:

```javascript

import ndarray from "ndarray";

const npyArray = ndarray(data, shape);

npyArray.get(10, 15)

```

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

Please report bugs or contribute pull-requests on [GitHub](https://github.com/aplbrain/npyjs).

---

Made with ♥ at