Overview

This module allows to load, parameterize, run and analyze OpenFLUID simulations from Node.js scripts.

It is compatible with Node.js 10.x and requires that the OpenFLUID platform and the CMake tool are already installed.

See the package.json file for Node.js dependencies.

Currently, this package is in early development stage and has only be tested on Linux system

Installation

From GitHub

Run the followind npm command

npm install OpenFLUID/openfluidjs

As a dependency for another module

Add OpenFLUIDjs GitHub repository as a dependency in the package.json file

{
  "name": "my-module",
  "version": "1.0.0",
  "dependencies": {
    "OpenFLUIDjs": "https://github.com/OpenFLUID/openfluidjs"
  }
}

Development

Run the following commands from the root of the sources tree.

Build

This command will install dependencies and build the module

npm install

Test

This command will run the tests

npm test

Packaging

This command will create a .tgz archive

npm pack

Misc resources

• https://nodejs.org/docs/latest/api/n-api.html
• https://github.com/nodejs/node-addon-api
• https://www.npmjs.com/package/cmake-js
• https://github.com/cmake-js/cmake-js-tut-01-module