Initial commit

Author: fabrejc

.gitignore

@@ -0,0 +1,12 @@
+node_modules
+build
+npm-debug.log
+
+*.OUT/
+OUT/
+
+*.tgz
+.env
+.DS_Store
+.*
+!.gitignore

CMakeLists.txt

@@ -0,0 +1,31 @@
+CMAKE_MINIMUM_REQUIRED(VERSION 3.0)
+
+
+PROJECT(OpenFLUIDjs)
+
+
+FIND_PACKAGE(OpenFLUIDHelpers REQUIRED)
+
+IF(COMMAND OPENFLUID_DETECT_CXX11)
+  OPENFLUID_DETECT_CXX11()
+ENDIF()
+
+FIND_PACKAGE(Qt5 COMPONENTS Core REQUIRED)
+FIND_PACKAGE(OpenFLUID REQUIRED core base ware machine tools fluidx)
+
+
+INCLUDE_DIRECTORIES(${OpenFLUID_INCLUDE_DIRS} ${CMAKE_JS_INC}
+                                              ${CMAKE_SOURCE_DIR}/node_modules/node-addon-api
+                                              ${CMAKE_SOURCE_DIR}/../node-addon-api
+                   )
+
+SET(OpenFLUIDjs_CPP_HPP src/OpenFLUIDjsWrapper.cpp)
+
+ADD_LIBRARY(OpenFLUIDjs SHARED ${OpenFLUIDjs_CPP_HPP})
+
+SET_TARGET_PROPERTIES(OpenFLUIDjs PROPERTIES PREFIX "lib" SUFFIX ".node")
+
+TARGET_LINK_LIBRARIES(OpenFLUIDjs ${OpenFLUID_LIBRARIES}
+                                  Qt5::Core
+                                  ${CMAKE_JS_LIB}
+                     )

LICENSE

@@ -0,0 +1,42 @@
+OpenFLUID
+Copyright (c) 2007 INRA - Montpellier SupAgro
+Inter Deposit Digital Number : IDDN.FR.001.360006.000.R.P.2009.000.30100
+
+
+ == GNU General Public License Usage ==
+
+  OpenFLUID is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  OpenFLUID is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>.
+
+
+ == Other Usage ==
+
+  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
+  license, and requires a written agreement between You and INRA.
+  Licensees for Other Usage of OpenFLUID may use this file in accordance
+  with the terms contained in the written agreement between You and INRA.
+
+
+===========================================================================
+
+
+OpenFLUID relies on third party libraries and content, under the following licensing terms:
+  - Boost: http://www.boost.org/users/license.html (Boost license)
+  - Qt: http://qt-project.org/doc/qt-5/opensourcelicense.html (LGPL)
+  - OGR/GDAL: http://trac.osgeo.org/gdal/wiki/FAQGeneral#WhatlicensedoesGDALOGRuse (X11/MIT)
+  - GEOS: http://trac.osgeo.org/geos/ (LGPL)
+  - RapidJSON: http://rapidjson.org (MIT)
+  - Material design icons: https://material.io/icons/ (Apache 2.0) and https://materialdesignicons.com/ (OFL-1.1)
+
+
+  

README.md

@@ -0,0 +1,68 @@
+## 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
+
+Thi 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

index.js

@@ -0,0 +1,37 @@
+var libOpenFLUID = require("bindings")("libOpenFLUIDjs");
+
+module.exports = {
+
+  getVersion: function() {
+    return libOpenFLUID.getVersion()
+  },
+
+  newBlob: function() {
+    return libOpenFLUID.newBlob();
+  },
+
+  deleteBlob: function(blob) {
+    libOpenFLUID.deleteBlob(blob);
+  },
+
+  printSimulationInfo: function(blob) {
+    libOpenFLUID.printSimulationInfo(blob);
+  },
+
+  openDataset: function(path) {
+    return libOpenFLUID.openDataset(path);
+  },
+
+  openProject: function(path) {
+    return libOpenFLUID.openProject(path);
+  },
+
+  setCurrentOutputDir: function(path) {
+    libOpenFLUID.setCurrentOutputDir(path);
+  },
+
+  runSimulation: function(blob,verbose=false) {
+    libOpenFLUID.runSimulation(blob,Boolean(verbose));
+  },
+
+};