⚠️ Notice: This package is still under construction and not fully production ready yet. API changes may occur and some features might be incomplete.
This project provides JavaScript/TypeScript support for reading and processing OmFile format data efficiently. OmFile format is a scientific data format optimized for meteorological data from the Open-Meteo project.
The repository is structured into two separate packages:
- file-format-wasm: WebAssembly bindings for the OmFileFormat C library
- file-reader: JavaScript/TypeScript API for working with OmFile data
- Efficient reading of OmFile format data through WebAssembly
- Support for multiple data sources (local files, HTTP, in-memory, S3)
- Browser and Node.js compatibility
- TypeScript support
- High-performance data access
npm install @openmeteo/file-readerUsage depends on the backend you want to use to access the data and the environment you are in (Node, Browser). Expect this to be improved in the future!
import { OmFileReader, FileBackendNode } from '@openmeteo/file-reader';
const backend = new FileBackendNode('/path/to/your/file.om');
const reader = await OmFileReader.create(backend);
const data = await reader.readVariable('temperature');
console.log(data);import { OmFileReader, FileBackend } from '@openmeteo/file-reader';
// Assume you have a <input type="file" id="fileInput" />
const fileInput = document.getElementById('fileInput');
fileInput.addEventListener('change', async (event) => {
const file = event.target.files[0];
const backend = new FileBackend(file);
const reader = await OmFileReader.create(backend);
const data = await reader.readVariable('temperature');
console.log(data);
});const buffer = new Uint8Array([...]); // Your OmFile data
const backend = new FileBackend(buffer);
const reader = await OmFileReader.create(backend);import { MemoryHttpBackend, OmFileReader } from '@openmeteo/file-reader';
const backend = new MemoryHttpBackend({ url: 'https://example.com/data.om' });
const reader = await OmFileReader.create(backend);- Node.js 16+
- Docker (for building the WebAssembly component)
# Clone the repository with submodules
git clone --recursive https://github.com/open-meteo/typescript-omfiles.git
# Install dependencies
npm install
# This will use docker emscripten/emsdk container
# to compile the C code to WASM
npm run build
# Run the tests
npm run testContributions are welcome! Please feel free to open an Issue or to submit a Pull Request.