Skip to content

Repository files navigation

netcdfjs

NPM version build status Test coverage npm download

Read and explore NetCDF v3 files.

Installation

$ npm install netcdfjs

For further information about the grammar you should go to this link.

Example

import { readFileSync } from 'node:fs';

import { NetCDFReader } from 'netcdfjs';

// http://www.unidata.ucar.edu/software/netcdf/examples/files.html
const data = readFileSync('madis-sao.nc');

const reader = new NetCDFReader(data); // read the header
reader.getDataVariable('wmoId'); // go to offset and read it

API

A NetCDFReader instance exposes:

Member Description
version 'classic format' or '64-bit offset format'.
dimensions List of dimensions, each with a name and a size.
recordDimension Metadata of the record dimension (length, id, name, recordStep).
globalAttributes List of global attributes, each with a name, a type and a value.
variables List of variables, each with a name, dimensions, attributes, type, size, offset.
getAttribute(name) Value of a global attribute, or null when it does not exist.
attributeExists(name) Whether a global attribute exists.
getDataVariable(nameOrVariable) Values of a variable. Throws when the variable does not exist.
getDataVariableAsString(name) Values of a variable joined into a string, or null when it does not exist.
dataVariableExists(name) Whether a variable exists.
toString() Human-readable description of the dimensions, global attributes and variables.

License

MIT

About

Read and explore NetCDF files

Topics

Resources

Stars

164 stars

Watchers

13 watching

Forks

Releases

Packages

Used by

Contributors

Languages