https://github.com/openfluid/openfluidjs
Node.js module for OpenFLUID
https://github.com/openfluid/openfluidjs
Last synced: 4 months ago
JSON representation
Node.js module for OpenFLUID
- Host: GitHub
- URL: https://github.com/openfluid/openfluidjs
- Owner: OpenFLUID
- License: other
- Created: 2018-08-22T13:43:35.000Z (almost 8 years ago)
- Default Branch: develop
- Last Pushed: 2024-11-19T14:22:31.000Z (over 1 year ago)
- Last Synced: 2024-11-19T15:30:42.724Z (over 1 year ago)
- Language: C++
- Size: 148 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 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](https://www.openfluid-project.org/) and the [CMake tool](https://www.cmake.org) 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