measur-tools-suite 1.0.11-beta.56 → 1.0.11-beta.65

package/CONTRIBUTING.md

@@ -410,7 +410,7 @@ void processData(const std::vector<int>& data) {
 
 ## Naming
 
-Naming conventions are crucial for maintaining a consistent and readable codebase. This section outlines the naming conventions for various elements in the code.
+Use the following naming conventions for various elements in the codebase to ensure consistency and readability.
 
 <!-- START mdsplit-ignore -->
 **[Return to Index](#style-guide-index)**
@@ -418,16 +418,10 @@ Naming conventions are crucial for maintaining a consistent and readable codebas
 
 ### Files
 
-Use `snake_case` suffixed with the appropriate file extension (`.h`, `.hpp`, or `.cpp`) for file names:
-
-```cpp
-my_class.h
-my_class.cpp
-```
+Use `snake_case` suffixed with the appropriate file extension (`.h`, `.hpp`, or `.cpp`) for file names (e.g., `my_class.h`, `my_class.cpp`).
 
 > [!NOTE]
-> This project uses `.h` for header files and `.cpp` for source files. 
-> File names should be descriptive and reflect the content or purpose of the file.
+> This project uses `.h` for header files and `.cpp` for source files.
 
 <!-- START mdsplit-ignore -->
 **[Return to Index](#style-guide-index)**
@@ -435,20 +429,7 @@ my_class.cpp
 
 ### Namespaces
 
-Namespaces names use `snake_case`:
-
-```cpp
-namespace my_project {
-namespace utils {
-
-// Utility functions go here.
-
-}  // namespace utils
-}  // namespace my_project
-```
-
-> [!NOTE]
-> All code in the namespace should be under one or more directories with the same name as the namespace.
+Use `snake_case` for namespace names (e.g., `my_project`, `utils`).
 
 <!-- START mdsplit-ignore -->
 **[Return to Index](#style-guide-index)**
@@ -456,17 +437,7 @@ namespace utils {
 
 ### Classes and Structs
 
-Use `PascalCase` for class and struct names:
-
-```cpp
-class MyClass {
-    // Class members
-};
-
-struct MyStruct {
-    // Struct members
-};
-```
+Use `PascalCase` for class and struct names (e.g., `MyClass`, `MyStruct`).
 
 <!-- START mdsplit-ignore -->
 **[Return to Index](#style-guide-index)**
@@ -474,14 +445,24 @@ struct MyStruct {
 
 ### Functions and Methods
 
-Use `camelCase` for function and method names:
+Use `camelCase` for function and method names (e.g., `myFunction`, `computeArea`).
 
-```cpp
-void myFunction();
+Use verbs or verb phrases for function names to indicate actions.
+
+- Accessor methods (getters) should be named after the property they return, without a `get` prefix (e.g., `eyeColor()`).
+- Mutator methods (setters) should be named with a `set` prefix followed by the property name (e.g., `setEyeColor()`).
 
-class MyClass {
+#### Example
+
+```cpp
+class Dog {
 public:
-    void myMethod();
+    std::string eyeColor() const { return eye_color_; } // Accessor for eye_color_
+
+    void setEyeColor(const std::string& color) { eye_color_ = color; } // Mutator for eye_color_
+
+private:
+    std::string eye_color_;
 };
 ```
 
@@ -491,7 +472,9 @@ public:
 
 ### Variables
 
-Local variables and function parameters use `snake_case`:
+Use `snake_case` for variable names and function parameters.
+
+#### Example
 
 ```cpp
 void processData(int input_value) {
@@ -505,37 +488,27 @@ void processData(int input_value) {
 
 ### Member Variables
 
-There are two common conventions for member variables:
+Use `snake_case` for member variable names, with a trailing underscore (`_`) to distinguish them from local variables and parameters.
 
-1. Underscore suffix:
+#### Example 
 
-   ```cpp
-   class MyClass {
-   private:
-       int value_;
-       std::string name_;
-   };
-   ```
-   
-2. `m_` prefix:
-   
-   ```cpp
-   class MyClass {
-   private:
-       int m_value;
-       std::string m_name;
-   };
-   ```
+```cpp
+class Dog {
+private:
+    std::string name_;
+    int age_;
+    std::string eye_color_;
+};
+```
 
-> [!NOTE]
-> This project uses the underscore suffix convention for class member variables. 
+Use `snake_case` for struct member variables without a trailing underscore.
 
-Struct member variables are named like ordinary nonmember variables, without the trailing underscore:
+#### Example
 
 ```cpp
-struct MyStruct {
-    int value;
-    std::string name;
+struct Point2 {
+    double x;
+    double y;
 };
 ```
 
@@ -545,7 +518,9 @@ struct MyStruct {
 
 ### Constants and Enums
 
-Use `PascalCase` for enum names and `PascalCase` prefixed with `k` for constants and enum values:
+Use `PascalCase` for enum names and `PascalCase` prefixed with `k` for constants and enum values.
+
+#### Example
 
 ```cpp
 enum class Color {
@@ -564,7 +539,9 @@ constexpr double kPi = 3.14159;
 
 ### Aliases
 
-Use `PascalCase` for type aliases defined with `using`:
+Use `PascalCase` for type aliases.
+
+#### Example
 
 ```cpp
 using StringList = std::vector<std::string>;
@@ -576,7 +553,9 @@ using StringList = std::vector<std::string>;
 
 ### Templates
 
-Use `PascalCase` for template parameters:
+Use `PascalCase` for template parameters.
+
+#### Example
 
 ```cpp
 template <typename InputType>
@@ -589,7 +568,9 @@ InputType processInput(InputType input);
 
 ### Macros
 
-Use `UPPER_CASE` with a project-specific prefix for macro names:
+Use `UPPER_CASE` with a project-specific prefix for macro names.
+
+#### Example
 
 ```cpp
 #define MYPROJECT_MAX(a, b) ((a) > (b) ? (a) : (b))

package/EMSCRIPTEN_BINDINGS_CHANGES.md

@@ -7,7 +7,7 @@ The following table summarizes the changes made to the Emscripten bindings in th
 | Previous Signature | Updated Signature     |
 | ------------------ | --------------------- |
 | getConditionFactor | shapeFactor           |
-| getID              | ID                    |
+| getID              | id                    |
 | getHeatLoss        | totalHeatLoss         |
 | getSurface         | surfaceDescription    |
 | setConditionFactor | setShapeFactor        |

package/README.md

@@ -27,42 +27,49 @@ The npm packages can be downloaded and install from [registry](https://www.npmjs
 #### Web Assembly Compilation SDK
 
 - Emscripten (emsdk) - Follow instructions for install https://emscripten.org/docs/getting_started/downloads.html
+- From the emsdk directory run `./emsdk install latest`
+- Then run `./emsdk activate latest`
+- Then run `source ./emsdk_env.sh` to set the environment variables in the current terminal session.
+  - On Windows use `emsdk_env.bat`
+
+> [!NOTE]
+> This needs to be done each time a new terminal session is started, or add the command to your shell profile script (e.g. .bashrc, .zshrc, etc.)
 
 #### Node
 - Node LTS [https://nodejs.org/en/](https://nodejs.org/en/) 
 
-### Build WebAssembly Module
-- Emscripten (emsdk) must be installed and activated
-- run `emcmake cmake -DBUILD_WASM=ON`
-  -   Note: If multiple compilers are present and default environment is not used, use -G "XXX Makefiles",
-        example for windows using MinGW => `emcmake cmake -D BUILD_WASM=ON .. -G "MinGW Makefiles"` 
-- run `emmake make`
-- Build artifacts: `client.js` and `client.wasm` will be created in the `/bin` directory. `client.js` is the glue code for initializing the WASM module, place the two files in the same directory within your project and execute the `client.js` script.
+### Build Web Assembly Module
+
+- Ensure you have followed the "Install and Activate Emscripten" steps above
+- From the root directory of the MEASUR Tools Suite repository run `emcmake cmake -DBUILD_WASM=ON`
+  > If multiple compilers are present and default environment is not used, use `-G "<XXX> Makefiles"`. For example, on Windows using MinGW: `emcmake cmake -D BUILD_WASM=ON .. -G "MinGW Makefiles"`
+- Then run `emmake make`
+  > This will create the build artifacts `client.js` and `client.wasm` in the `/bin` directory. `client.js` is the glue code for initializing the WASM module. Place the two files in the same directory within your project and execute the `client.js` script.
 
 ### WASM Initialization Example
 
-Below is an illustration of the WASM initialization process:
+MEASUR Tools Suite is distributed as a modularized WebAssembly Module. 
+Below is an illustration of the WASM initialization and usage process:
 
 ![WASM Initialization](assets/wasm-initialization.png)
 
-### Running WASM Unit Tests
-
-- Follow the "Build WebAssembly Module" steps above
-- run `npm install` to install node dependencies
-- run `npm run test-wasm`
-- a simple express server will be server to `localhost:3000` and a batch of script testing files will be executed
+### WASM Unit Tests
 
+- Ensure you have followed the "Build WebAssembly Module" steps above
+- From the root directory of the MEASUR Tools Suite repository run `npm install` to install node dependencies
+- Then run `npm run test-wasm-mocha`
+  > All mocha tests found under `tests/wasm-mocha/` will be executed. 
+  > Migration of unit tests to the mocha framework is a WIP.
 
 ### C++ Unit Tests
 
-- To build C++ unit tests, ensure the `BUILD_TESTING` flag is set (which is default) then: 
-  - create directory `build-cpp` and cd into it
-  - run `'cmake ..'`  
-    -   Note: If multiple compilers are present and default environment is not used, use -G "XXX Makefiles",
-    example for windows using MinGW => `cmake .. -G "MinGW Makefiles"`
-  - run `'cmake --build .'`
-  - execute `./cpp_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
+- Ensure the `BUILD_TESTING` flag is set (which is default) when running CMake
+- From the root directory of the MEASUR Tools Suite repository, run `mkdir build-cpp` and `cd build-cpp`
+- Then run `cmake ..`  
+  > If multiple compilers are present and default environment is not used, use `-G "XXX Makefiles"`. For example for windows using MinGW => `cmake .. -G "MinGW Makefiles"`
+- Then run `cmake --build .`
+- Then run `cd bin` and `./cpp_tests` to execute the tests
+  > On Windows, the executable can be found under either the `Debug` or `Release` directories, depending on CMake configuration
 
 ### Packaging
 
@@ -70,9 +77,11 @@ Below is an illustration of the WASM initialization process:
 - 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
+### Generate Documentation Locally
 
-- To generate documentation: `doxygen Doxyfile`
+- Ensure Doxygen (v 1.14.0 or later) is installed
+- From the root directory of the MEASUR Tools Suite repository run `doxygen Doxyfile`
+  > The documentation will be generated in the `/docs/html` directory
 
 ### Dockerizing 
 
@@ -87,5 +96,3 @@ To make it easy for developers local building and testing, it is dockerized. To
     - Note: 
       - Every time the container is started it will rebuild the application, to check status run `docker compose logs --tail 5` 
       - **This is not a tutorial for docker, assumption is made the user is knowledgeable.**
-
-