amo-tools-suite

Calculation library for the Department of Energy Advanced Manufacturing Office (DOE AMO) suite of tools

Usage no npm install needed!

<script type="module">
  import amoToolsSuite from 'https://cdn.skypack.dev/amo-tools-suite';
</script>

README

AMO Tools Suite

AMO Tools Suite is a cross-platform collection of calculations and tools to support industrial equipment modeling. See our hosted documentation for the latest release at ornl-amo.github.io

Dependencies

C++

  • make
  • CMake (cmake-curses to use the ccmake gui)
  • GCC 4.8.5 or later
    • Windows: Visual Studio Build Tools or Cygwin with other C++ compiler
  • Doxygen (only for building documentation)

Web Assembly Compilation SDK

Node

Building

  • Install node_modules dependencies: cd into AMO-Tools-Suite directory and run
    npm install
  • cd into the emsdk directory:
    • run emsdk activate 2.0.16 (Build must target this version)
  • cd into AMO-Tools-Suite directory:
    • run emcmake cmake -DBUILD_WASM=ON -G "MinGW Makefiles"
      • Note: If multiple compilers are present and default environment is not used, use -G "XXX Makefiles", example for windows => emcmake cmake -D BUILD_WASM=ON -G "MinGW Makefiles"
    • run emmake mingw32-make (or other make-file)

Building for NAN module use (Legacy)

  • Edit the CMakeCache and enable desired build options via the ccmake tool: ccmake . and make to build
  • If ccmake isn't available, use cmake -D BUILD_TESTING:BOOL=ON -D BUILD_PACKAGE:BOOL=OFF --config Debug ./ and cmake --build . where config can be Release, Debug, MinSizeRel or RelWithDebInfo
  • To build node modules: npm install or if already installed, node-gyp rebuild to rebuild the modules

Unit Tests

  • To run the JavaScript unit tests for the node addons: npm run test
  • To run the WASM unit tests use: npm run test-wasm
  • To build C++ unit tests directly, ensure the BUILD_TESTING flag is set then: cmake --build . --target amo_tools_suite_tests
  • On MacOS or Linux, the test executable can be found under the bin directory. On Windows, the executable can be found under either the Debug or Release directories, depending on CMake configuration

Acceptance Tests

  • To run the JavaScript acceptance tests (roundtrip testing of JavaScript bindings to calculations to output validation): npm run at

Packaging

  • Enable the BUILD_PACKAGE flag in the CMakeCache, then cmake ./ then make package
  • Or use this directly for Windows: cmake -D BUILD_TESTING:BOOL=OFF ./ and cmake --build . --config Release --target PACKAGE
  • To make package on Linux or Mac, run ccmake. and set BUILD_TESTING OFF, BUILD_PACKAGE ON, then configure and generate. Then make package.

Documentation

  • To generate documentation: doxygen Doxyfile.in