measur-tools-suite 1.0.11-beta.95 → 1.0.11-beta.97

package/CONTRIBUTING.md

@@ -58,13 +58,9 @@ Use Conventional Commits to structure your commit messages. This helps maintain
   - [How to Format Code](#how-to-format-code)
   - [Best Practices](#best-practices)
 - [Documentation](#documentation)
-  - [Doxygen Commands](#doxygen-commands)
-  - [Doxygen Aliases](#doxygen-aliases)
+  - [Common Doxygen Tags](#common-doxygen-tags)
+  - [How to Generate Doxygen Documentation](#how-to-generate-doxygen-documentation)
   - [Documenting Code](#documenting-code)
-    - [Math](#math)
-    - [Units](#units)
-    - [Formulas](#formulas)
-    - [Symbols](#symbols)
     - [Files](#files-1)
     - [Namespaces](#namespaces-2)
     - [Classes \& Structs](#classes--structs)
@@ -72,8 +68,9 @@ Use Conventional Commits to structure your commit messages. This helps maintain
     - [Member Variables](#member-variables-1)
     - [Constants](#constants)
     - [Enums](#enums)
-    - [Groups](#groups)
-  - [Generating Doxygen Documentation](#generating-doxygen-documentation)
+    - [Formulas](#formulas)
+    - [Units](#units)
+    - [Modules](#modules)
 - [Conventional Commits](#conventional-commits)
   - [Commit Format](#commit-format)
   - [Commit Types](#commit-types)
@@ -701,7 +698,7 @@ If you have questions about the formatting rules or need help configuring your e
 
 # Documentation
 
-This project uses [Doxygen](https://www.doxygen.nl/) to generate documentation from annotated source code. Doxygen comments are used to describe the purpose, behavior, and usage of classes, functions, and other entities in the codebase. Follow these guidelines to ensure your code is well-documented and easy to understand. Always use `@` for Doxygen commands.
+This project uses [Doxygen](https://www.doxygen.nl/) to generate documentation from annotated source code. Doxygen comments are used to describe the purpose, behavior, and usage of classes, functions, and other entities in the codebase. Follow these guidelines to ensure your code is well-documented and easy to understand. Always use `@` for Doxygen commands and tags, as this is the standard convention in this project.
 
 <!-- START mdsplit-ignore -->
 <a id="documentation-index"></a>
@@ -709,13 +706,9 @@ This project uses [Doxygen](https://www.doxygen.nl/) to generate documentation f
 <summary><Strong>Index</Strong></summary>
 
 - [Documentation](#documentation)
-  - [Doxygen Commands](#doxygen-commands)
-  - [Doxygen Aliases](#doxygen-aliases)
+  - [Common Doxygen Tags](#common-doxygen-tags)
+  - [How to Generate Doxygen Documentation](#how-to-generate-doxygen-documentation)
   - [Documenting Code](#documenting-code)
-    - [Math](#math)
-    - [Units](#units)
-    - [Formulas](#formulas)
-    - [Symbols](#symbols)
     - [Files](#files-1)
     - [Namespaces](#namespaces-2)
     - [Classes \& Structs](#classes--structs)
@@ -723,53 +716,68 @@ This project uses [Doxygen](https://www.doxygen.nl/) to generate documentation f
     - [Member Variables](#member-variables-1)
     - [Constants](#constants)
     - [Enums](#enums)
-    - [Groups](#groups)
-  - [Generating Doxygen Documentation](#generating-doxygen-documentation)
+    - [Formulas](#formulas)
+    - [Units](#units)
+    - [Modules](#modules)
 
 </details>
 <!-- END mdsplit-ignore -->
 
 ## Doxygen Commands
 
-All commands must start with `@`. 
+All commands start with `@`. 
 
-Useful Commands:
+Some commands have one or more arguments. Each argument has a certain range:
+- If `<sharp>` braces are used the argument is a single word.
+- If `(round)` braces are used the argument extends until the end of the line on which the command was found.
+- If `{curly}` braces are used the argument extends until the next paragraph. Paragraphs are delimited by a blank line or by a section indicator.
+
+Commands:
 - `@file <name>`
-- `@authors <authors>`
-- `@ingroup <group-name>`
-- `@defgroup <name> <group-title>`
+- `@authors { list of authors }`
+- `@ingroup (<group-name>)`
+- `@defgroup <name> (group title)`
 - `@namespace <name>`
 - `@class <name>`
 - `@struct <name>`
 - `@enum <name>`
-- `@brief <brief description>`
-- `@details <detailed description>`
-- `@param[<direction>] <parameter-name> <parameter-description>`
-- `@tparam <template-parameter-name> <description>`
-- `@return <description>`
-- `@throws <exception-object> <description>`
-- `@note <text>`
-- `@bug <description>`
-- `@see <reference>`
-- `@copyright <text>`
-- `@cite <reference>`
-- `@ref <reference> <display-text>`
+- `@brief { brief description }`
+- `@details { detailed description }`
+- `@param[<dir>] <parameter-name> { parameter description }`
+- `@tparam <template-parameter-name> { description }`
+- `@return { description of the return value }`
+- `@throws <exception-object> { exception description }`
+- `@note { text }`
+- `@bug { bug description }`
+- `@see { references }`                                       
+- `@def <name>`                                      
+- `@copyright { copyright description }`
 
 <!-- START mdsplit-ignore -->
 **[Return to Index](#documentation-index)**
 <!-- END mdsplit-ignore -->
 
-## Doxygen Aliases
+## Custom Commands
 
-The following Doxygen aliases are defined in the `Doxyfile` to simplify common documentation tasks:
 - `@math{<math expression>}`
-- `@unitr{<unit expression>}`
-- `@unitb{<unit expression>}`
-- `@unitp{<unit expression>}`
+- `@unit{<unit expression>}`
 - `@formula{<label>; <equation>}`
-- `@symtable`
-- `@symrow{<symbol>; <description>; <unit expression>}`
-- `@endsymtable`
+- `symbol{<symbol>; <description>}`
+
+<!-- START mdsplit-ignore -->
+**[Return to Index](#documentation-index)**
+<!-- END mdsplit-ignore -->
+
+## Generating Doxygen Documentation
+
+1. Ensure [Doxygen](https://www.doxygen.nl/) is installed on your system.
+2. From the project root, run:
+   ```bash
+   doxygen Doxyfile
+   ```
+3. The generated HTML and/or LaTeX documentation will appear in the output directory specified in your `Doxyfile`.
+
+For more details on configuring or customizing Doxygen output, see the official [Doxygen manual](https://www.doxygen.nl/manual/index.html) or review the `Doxyfile` in the project root.
 
 <!-- START mdsplit-ignore -->
 **[Return to Index](#documentation-index)**
@@ -801,13 +809,13 @@ Use the `@math{<math expression>}` command to to write LaTeX-style mathematical
 
 ### Units
 
-Use the `@unitb{<unit expression>}` command to document units. The `@unitb{}` command uses the siunitx package to format units in LaTeX style and encloses them in brackets.
+Use the `@unit{<unit expression>}` command to document units. The `@unit{}` command uses the siunitx package to format units in LaTeX.
 
 #### Example
 
 ```cpp
 /**
- * The speed of light in water is often denoted as @math{C_w} and is approximately 2.25 @unitb{\meter\per\second}.
+ * The speed of light in water is often denoted as @math{C_w} and is approximately 2.25 @unit{\meter\per\second}.
  */
 ```
 
@@ -818,7 +826,7 @@ Use the `@unitb{<unit expression>}` command to document units. The `@unitb{}` co
 ### Formulas
 
 Use the `@formula{<label>; <equation>}` command to document formulas. The command takes 2 arguments, separated by `;`:
-1. A label for the formula, which can be used to reference the formula in the documentation by using `\eqref{eq:<formula-label>}`.
+1. A label for the formula, which can be used to reference the formula in the documentation by using `\eqref{eq:formula-label}`.
    - All labels are automatically prefixed with `eq:` to avoid conflicts.
 2. The formula itself, written in LaTeX syntax.
 
@@ -841,10 +849,9 @@ Use the `@formula{<label>; <equation>}` command to document formulas. The comman
 
 ### Symbols
 
-Use the `@symtable` and `@endsymtable` commands to create a table of symbols used in formulas. Each symbol is documented using the `@symrow{<symbol>; <description>; <unit expression>}` command, which takes three arguments, separated by `;`:
+Use the `symbol{<symbol>; <description>}` command to document mathematical symbols. This command takes two arguments, separated by `;`:
 1. The symbol itself, written in LaTeX syntax.
 2. A description of the symbol.
-3. The unit of the symbol, written in LaTeX syntax and formatted using the siunitx package.
 
 #### Example
 
@@ -853,11 +860,9 @@ Use the `@symtable` and `@endsymtable` commands to create a table of symbols use
  * The area of a circle can be computed using the formula:
  * @formula{circle-area; A = \pi r^2}
  * where:
- * @symtable
- * @symrow{A; is the area of the circle; \meter\squared}
- * @symrow{\pi; is the mathematical constant pi; 1}
- * @symrow{r; is the radius of the circle; \meter}
- * @endsymtable
+ * - @symbol{A; is the area of the circle}
+ * - @symbol{\pi; is the mathematical constant pi}
+ * - @symbol{r; is the radius of the circle}
  */
 ```
 
@@ -869,27 +874,25 @@ Use the `@symtable` and `@endsymtable` commands to create a table of symbols use
 
 Use a **Doxygen block** at the very top of each header file to document the file's purpose, authors, and any relevant notes.
 
-#### Relevant commands
+#### Required tags
+
+`@file`, `@authors`, `@ingroup`, `@brief`
 
-- `@ingroup`
-- `@file`
-- `@authors`
-- `@brief`
-- `@details`
-- `@note`
-- `@see`
-- `@copyright`
+#### Optional tags
+
+`@details`, `@note`, `@bug`, `@see`, `@copyright`
 
 #### Example
 
 ```cpp
 /**
- * @ingroup geometry
  * @file polygon.h
  * @authors Alice Brown, Carlos Diaz
+ * @ingroup geometry
  * @brief Defines the Polygon class for representing simple 2-D polygons.
  * @details This file contains the Polygon class, which provides methods for adding vertices, computing area, and checking point containment.
  * @note The Polygon class assumes vertices are provided in counter-clockwise order.
+ * @bug Self-intersection checks are not implemented.
  * @see https://en.wikipedia.org/wiki/Polygon
  * @copyright 2025 Geometry Toolkit
  */
@@ -903,21 +906,20 @@ Use a **Doxygen block** at the very top of each header file to document the file
 
 Use a **Doxygen block** above each namespace declaration in header files to document the namespace's purpose and contents.
 
-#### Relevant commands
+#### Required tags
+
+`@namespace`, `@ingroup`, `@brief`
 
-- `@ingroup`
-- `@namespace`
-- `@brief`
-- `@details`
-- `@note`
-- `@see`
+#### Optional tags
+
+`@details`, `@note`, `@see`
 
 #### Example
 
 ```cpp
 /**
- * @ingroup math
  * @namespace constants
+ * @ingroup math
  * @brief Defines mathematical constants used throughout the project.
  */
 namespace constants {}
@@ -931,24 +933,20 @@ namespace constants {}
 
 Use a **Doxygen block** above each class or struct declaration in header files to document its purpose, behavior, and any important details. This applies to both classes and structs.
 
-#### Relevant commands
+#### Required tags
 
-- `@ingroup`
-- `@class`
-- `@struct`
-- `@brief`
-- `@details`
-- `@tparam`
-- `@note`
-- `@bug`
-- `@see`
+`@class` **or** `@struct`, `@ingroup`, `@brief`
+
+#### Optional tags
+
+`@details`, `@tparam`, `@note`, `@bug`, `@see`
 
 #### Example
 
 ```cpp
 /**
- * @ingroup geometry
  * @struct Point2
+ * @ingroup geometry
  * @brief Lightweight 2-D point with double precision.
  */
 struct Point2 {
@@ -957,8 +955,8 @@ struct Point2 {
 };
 
 /**
- * @ingroup geometry
  * @class Polygon
+ * @ingroup geometry
  * @brief Simple 2-D polygon representation.
  * @details Stores vertices in counter-clockwise order.
  * @note Capacity is fixed at construction.
@@ -986,12 +984,9 @@ public:
      * @details Uses the Shoelace formula to compute the area:
      * @formula{polygon-area; A = \frac{1}{2} \sum_{i=1}^{n} (x_i y_{i+1} - x_{i+1} y_i)}
      * where:
-     * @symtable
-     * @symrow{A; is the signed area of the polygon; \meter\squared}
-     * @symrow{n; is the number of vertices; 1}
-     * @symrow{x_i, y_i; are the coordinates of vertex i; \meter}
-     * @symrow{x_{n+1}, y_{n+1}; are the coordinates of vertex 1 (wrap-around); \meter}
-     * @endsymtable
+     * - @symbol{A; is the signed area}
+     * - @symbol{x_i \& y_i; are the coordinates of the i-th vertex}
+     * - @symbol{n; is the number of vertices}
      * @note The area is positive if vertices are in counter-clockwise order. 
      * @return The signed area of the polygon.
      */
@@ -1010,17 +1005,13 @@ private:
 
 Use a **Doxygen block** above each public function or method declaration in header files. This applies to both free functions and member functions of classes or structs.
 
-#### Relevant commands
+#### Required tags
+
+`@brief`, `@param[in]` **or** `param[out]` **or** `param[in,out]`, `@return` (if applicable)
 
-- `@brief`
-- `@param[in]` **or** `param[out]` **or** `param[in,out]`
-- `@return`
-- `@details`
-- `@tparam`
-- `@throws`
-- `@note`
-- `@bug`
-- `@see`
+#### Optional tags
+
+`@details`, `@tparam`, `@throws`, `@note`, `@bug`, `@see`
 
 #### Example
 
@@ -1059,7 +1050,7 @@ Use inline comments with `///<` to document constants and their purpose.
 #### Example
 
 ```cpp
-constexpr double kPi = 3.141592653589793;    ///< Circle ratio @unitb{radians}.
+constexpr double kPi = 3.141592653589793;    ///< Circle ratio @unit{radians}.
 inline constexpr Point2 kOrigin {0.0, 0.0};  ///< Reference point (0,0).
 ```
 
@@ -1071,22 +1062,20 @@ inline constexpr Point2 kOrigin {0.0, 0.0};  ///< Reference point (0,0).
 
 Use a **Doxygen block** above each enum declaration in header files to document the enum type and its enumerators. Each enumerator should have an inline comment describing its purpose.
 
-#### Relevant commands
+#### Required tags
+
+`@enum`, `@ingroup`, `@brief`
 
-- `@ingroup`
-- `@enum`
-- `@brief`
-- `@details`
-- `@note`
-- `@bug`
-- `@see`
+#### Optional tags
+
+`@details`, `@note`, `@bug`, `@see`
 
 #### Example
 
 ```cpp
 /**
- * @ingroup geometry
  * @enum Axis
+ * @ingroup geometry
  * @brief Principal 3-D axes.
  */
 enum class Axis {
@@ -1104,23 +1093,21 @@ enum class Axis {
 
 Use **Doxygen groups** to organize related namespaces, classes, and functions into logical modules.
 
-Large groups must be defined in their own file (e.g., `math.dox`, `geometry.dox`) to avoid cluttering header files. These files should be placed in the `docs/` directory or one of its subdirectories.
+Place a **Doxygen block** in a central location (e.g., `mainpage.dox`) to define the group and provide an overview. Each related code element should reference the group using the `@ingroup` command in its own documentation block.
+
+#### Required tags
+
+`@defgroup`, `@brief`
 
-#### Relevant commands
+#### Optional tags
 
-- `@defgroup`
-- `ingroup`
-- `@brief`
-- `@details`
-- `@copydoc`
-- `@see`
+`@details`, `@note`, `@see`
 
 #### Example
 
 ```cpp
 /**
  * @defgroup geometry Geometry
- * @ingroup math
  * @brief Geometry module for 2D and 3D shapes.
  */
 ```
@@ -1129,24 +1116,6 @@ Large groups must be defined in their own file (e.g., `math.dox`, `geometry.dox`
 **[Return to Index](#documentation-index)**
 <!-- END mdsplit-ignore -->
 
-<!-- START mdsplit-ignore -->
-## Generating Doxygen Documentation
-
-Use the `Doxyfile` to configure Doxygen settings like input/output directories, file patterns, and more.
-
-Use the `DoxygenLayout.xml` file to customize the layout of the generated documentation.
-
-To generate the documentation, follow these steps:
-1. Ensure [Doxygen](https://www.doxygen.nl/) is installed.
-2. From the project root, run:
-   ```bash
-   doxygen Doxyfile
-   ```
-3. The generated HTML and/or LaTeX documentation will appear in the output directory specified in the `Doxyfile`.
-
-**[Return to Index](#documentation-index)**
-<!-- END mdsplit-ignore -->
-
 # Conventional Commits
 
 This project follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for commit messages to ensure clarity, consistency, and automation in version control. This helps in generating changelogs, automating releases, and improving collaboration among contributors.

package/EMSCRIPTEN_BINDINGS_CHANGES.md

@@ -4,16 +4,12 @@ The following table summarizes the changes made to the Emscripten bindings in th
 
 ## WallLosses class
 
-The `WallLosses` class has been refactored into a namespace called `wall_heat_loss` with many methoids being removed or renamed. The following table outlines the updated emscripten bindings:
+| Previous Signature | Updated Signature     |
+| ------------------ | --------------------- |
+| getConditionFactor | shapeFactor           |
+| getID              | id                    |
+| getHeatLoss        | totalHeatLoss         |
+| getSurface         | surfaceDescription    |
+| setConditionFactor | setShapeFactor        |
+| setSurface         | setSurfaceDescription |
 
-| Current Signature                | Previous Signature | Notes                                                                 |
-| -------------------------------- | ------------------ | --------------------------------------------------------------------- |
-| totalHeatLoss                    | getHeatLoss        | Renamed                                                               |
-| convectiveHeatLoss               | ---                | New standalone method to calculate convective heat loss.              |
-| radiativeHeatLoss                | ---                | New standalone method to calculate radiative heat loss.               |
-| ShapeFactor                      | ---                | New Struct that holds shape factor data (description & factor value). |
-| ShapeFactor.surfaceConfiguration | surfaceDescription | New field in ShapeFactor struct that holds the description.           |
-| ShapeFactor.value                | shapeFactor        | New field in ShapeFactor struct that holds the factor value.          |
-| shapeFactors                     | ---                | New method that returns a vector of ShapeFactor structs.              |
-
-See `wasm_wall_heat_loss.test.js` for usage examples.

package/README.md

@@ -26,130 +26,73 @@ The npm packages can be downloaded and install from [registry](https://www.npmjs
 
 #### Web Assembly Compilation SDK
 
-- [Install Emscripten (emsdk)](https://emscripten.org/docs/getting_started/downloads.html)
-- Navigate to the `emsdk` directory.
-- Run the following commands in order:
-  ```bash
-  ./emsdk install latest
-  ```
-  ```bash
-  ./emsdk activate latest
-  ```
-  ```bash
-  source ./emsdk_env.sh
-  ``` 
-  > This sets up the current terminal session to use the Emscripten tools. 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.)
+- 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`
 
-#### Node
+> [!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 Web Assembly Module
 
-- Ensure Emscripten environment is activated (see above).
-- Naviagate to the root directory of the MEASUR Tools Suite repository.
-- Run the following commands in order:
-  ```bash
-  emcmake cmake -DBUILD_WASM=ON
-  ```
-  > If multiple compilers are present and default environment is not used, use `-G "<XXX> Makefiles"`. On Windows using MinGW: `emcmake cmake -D BUILD_WASM=ON .. -G "MinGW Makefiles"`
-  ```bash
-  emmake make
-  ```
+- 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
 
-MEASUR Tools Suite is distributed as a modularized WebAssembly Module. Below is an illustration of the WASM initialization and usage process:
+MEASUR Tools Suite is distributed as a modularized WebAssembly Module. 
+Below is an illustration of the WASM initialization and usage process:
 
-<!-- TODO: Replace with updated code snippet -->
 ![WASM Initialization](assets/wasm-initialization.png)
 
 ### WASM Unit Tests
 
-- Ensure Emscripten environment is activated (see above).
-- Navigate to the root directory of the MEASUR Tools Suite repository.
-- Run the following commands in order:
-  ```bash
-  npm install
-  ``` 
-  > This will install the node dependencies.
-  ```bash
-  npm run test:browser
-  ```
-  > All mocha tests found under `tests/wasm-mocha/` will be executed. Migration of unit tests to the mocha framework is a WIP.
+- 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
 
-- Ensure the CMake flag `BUILD_TESTING` is set (which is default).
-- Navigate to the root directory of the MEASUR Tools Suite repository.
-- Run the following commands in order:
-  ```bash
-  mkdir build-cpp
-  ```
-  ```bash
-  cd build-cpp
-  ```
-  ```bash
-  cmake ..
-  ```  
-  > If multiple compilers are present and default environment is not used, use `-G "XXX Makefiles"`. For windows using MinGW => `cmake .. -G "MinGW Makefiles"`
-  ```bash
-  cmake --build .
-  ```
-  ```bash
-  cd bin
-  ```
+- 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
-  ```bash
-  ./cpp_tests
-  ```
-  
 
 ### 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`.
+- To make package on Linux or Mac, run `ccmake.` and set BUILD_TESTING OFF, BUILD_PACKAGE ON, then configure and generate. Then `make package`.
 
 ### Generate Documentation Locally
 
-- Ensure Doxygen (v 1.14.0 or later) is installed.
-- Navigate to the root directory of the MEASUR Tools Suite repository.
-- Run:
-  ```
-  doxygen Doxyfile
-  ```
-  > The documentation will be generated in the `/docs/html` directory.
+- 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 
 
 To make it easy for developers local building and testing, it is dockerized. To run it in docker follow these steps.
 
-- Navigate to the root directory of the MEASUR Tools Suite repository.
-- To build the docker image run:
-  ```bash
-  docker compose up -d
-  ```
-- To stop the container run:
-  ```bash
-  docker compose down
-  ```
-- To run the unit tests (both WASM and C++):
-  - WASM: In a browser, launch [http://localhost:3000/](http://localhost:3000/)
-  - C++: Run the following commands in order:
-    ```bash
-    docker exec -it measur-tools-suite-build /bin/bash
-    ```
-    ```bash
-    cd /usr/src/app/build-cpp/bin
-    ```
-    ```bash
-    ./cpp_tests
-    ```
-
-> [!NOTE]
-> Every time the container is started it will rebuild the application. To check status run: `docker compose logs --tail 5`.
+- Download the repository
+- Open command line tool, change directory to the repository run `docker compose up -d`
+- To stop the running container run `docker compose down`
+- Running Unit Tests
+  - WASM: in a browser, launch [http://localhost:3000/](http://localhost:3000/)
+  - C++: run `docker exec -it measur-tools-suite-build /bin/bash` and run the executable `/home/MEASUR-Tools-Suite/build-cpp/cpp_tests`
+    - 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.**