materials-marketplace · Kirankumaraswamy · Nov 3, 2022 · Nov 3, 2022 · Dec 12, 2022 · Dec 12, 2022
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -13,8 +13,10 @@ formats:
   - pdf
   - epub
 
-# Optionally set the version of Python and requirements required to build your docs
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
 python:
-  version: "3.8"
   install:
     - requirements: requirements.txt
diff --git a/docs/source/_static/img/standalone_apps/balancer_input.png b/docs/source/_static/img/standalone_apps/balancer_input.png
diff --git a/docs/source/_static/img/standalone_apps/balancer_output.png b/docs/source/_static/img/standalone_apps/balancer_output.png
diff --git a/docs/source/_static/img/standalone_apps/hookes_law.png b/docs/source/_static/img/standalone_apps/hookes_law.png
diff --git a/docs/source/_static/img/standalone_apps/hookes_law_output.png b/docs/source/_static/img/standalone_apps/hookes_law_output.png
diff --git a/docs/source/_static/img/standalone_apps/image_output.png b/docs/source/_static/img/standalone_apps/image_output.png
diff --git a/docs/source/_static/img/standalone_apps/laser_inputs.png b/docs/source/_static/img/standalone_apps/laser_inputs.png
diff --git a/docs/source/_static/img/standalone_apps/text_outputs.png b/docs/source/_static/img/standalone_apps/text_outputs.png
diff --git a/docs/source/_static/img/standalone_apps/weld_input_1.png b/docs/source/_static/img/standalone_apps/weld_input_1.png
diff --git a/docs/source/_static/img/standalone_apps/weld_input_2.png b/docs/source/_static/img/standalone_apps/weld_input_2.png
diff --git a/docs/source/_static/img/standalone_apps/weld_input_3.png b/docs/source/_static/img/standalone_apps/weld_input_3.png
diff --git a/docs/source/_static/img/standalone_apps/weld_output_1.png b/docs/source/_static/img/standalone_apps/weld_output_1.png
diff --git a/docs/source/_static/img/standalone_apps/weld_output_2.png b/docs/source/_static/img/standalone_apps/weld_output_2.png
diff --git a/docs/source/_static/img/ucs/uc1/MicressParameters.png b/docs/source/_static/img/ucs/uc1/MicressParameters.png
diff --git a/docs/source/_static/img/ucs/uc1/SimPARTIXparameters.png b/docs/source/_static/img/ucs/uc1/SimPARTIXparameters.png
diff --git a/docs/source/_static/img/ucs/uc1/combineModels.png b/docs/source/_static/img/ucs/uc1/combineModels.png
diff --git a/docs/source/_static/img/ucs/uc1/convertVTKforMicress.jpeg b/docs/source/_static/img/ucs/uc1/convertVTKforMicress.jpeg
diff --git a/docs/source/_static/img/ucs/uc1/images.ai b/docs/source/_static/img/ucs/uc1/images.ai
diff --git a/docs/source/_static/img/ucs/uc1/initiateMicress.png b/docs/source/_static/img/ucs/uc1/initiateMicress.png
diff --git a/docs/source/_static/img/ucs/uc1/particleMelting.png b/docs/source/_static/img/ucs/uc1/particleMelting.png
diff --git a/docs/source/_static/img/ucs/uc1/physicalPhenomena.png b/docs/source/_static/img/ucs/uc1/physicalPhenomena.png
diff --git a/docs/source/_static/img/ucs/uc1/resultMicress.jpeg b/docs/source/_static/img/ucs/uc1/resultMicress.jpeg
diff --git a/docs/source/_static/img/ucs/uc1/showDiscretization.jpeg b/docs/source/_static/img/ucs/uc1/showDiscretization.jpeg
diff --git a/docs/source/_static/img/ucs/uc1/workflow.png b/docs/source/_static/img/ucs/uc1/workflow.png
diff --git a/docs/source/_static/img/ucs/uc2/define_quantities.png b/docs/source/_static/img/ucs/uc2/define_quantities.png
diff --git a/docs/source/_static/img/ucs/uc2/download.png b/docs/source/_static/img/ucs/uc2/download.png
diff --git a/docs/source/_static/img/ucs/uc2/initial.png b/docs/source/_static/img/ucs/uc2/initial.png
diff --git a/docs/source/_static/img/ucs/uc2/levelling_process.png b/docs/source/_static/img/ucs/uc2/levelling_process.png
diff --git a/docs/source/_static/img/ucs/uc2/post_process.png b/docs/source/_static/img/ucs/uc2/post_process.png
diff --git a/docs/source/_static/img/ucs/uc2/postprocess_button.png b/docs/source/_static/img/ucs/uc2/postprocess_button.png
diff --git a/docs/source/_static/img/ucs/uc2/prepare2run.png b/docs/source/_static/img/ucs/uc2/prepare2run.png
diff --git a/docs/source/_static/img/ucs/uc2/rheometer_image.png b/docs/source/_static/img/ucs/uc2/rheometer_image.png
diff --git a/docs/source/_static/img/ucs/uc2/rheometer_image_1.png b/docs/source/_static/img/ucs/uc2/rheometer_image_1.png
diff --git a/docs/source/_static/img/ucs/uc2/rheometer_image_2.png b/docs/source/_static/img/ucs/uc2/rheometer_image_2.png
diff --git a/docs/source/_static/img/ucs/uc2/running.png b/docs/source/_static/img/ucs/uc2/running.png
diff --git a/docs/source/_static/img/ucs/uc2/running_completed.png b/docs/source/_static/img/ucs/uc2/running_completed.png
diff --git a/docs/source/_static/img/ucs/uc2/uc2_app.png b/docs/source/_static/img/ucs/uc2/uc2_app.png
diff --git a/docs/source/_static/img/ucs/uc3/Ap1_pt1.png b/docs/source/_static/img/ucs/uc3/Ap1_pt1.png
diff --git a/docs/source/_static/img/ucs/uc3/Ap1_pt2.png b/docs/source/_static/img/ucs/uc3/Ap1_pt2.png
diff --git a/docs/source/_static/img/ucs/uc3/Ap1_pt3.png b/docs/source/_static/img/ucs/uc3/Ap1_pt3.png
diff --git a/docs/source/_static/img/ucs/uc3/Ap1_pt4.png b/docs/source/_static/img/ucs/uc3/Ap1_pt4.png
diff --git a/docs/source/_static/img/ucs/uc3/Ap1_pt5.png b/docs/source/_static/img/ucs/uc3/Ap1_pt5.png
diff --git a/docs/source/_static/img/ucs/uc3/Ap2_pt1.png b/docs/source/_static/img/ucs/uc3/Ap2_pt1.png
diff --git a/docs/source/_static/img/ucs/uc3/Ap2_pt2.png b/docs/source/_static/img/ucs/uc3/Ap2_pt2.png
diff --git a/docs/source/_static/img/ucs/uc3/Ap2_pt3.png b/docs/source/_static/img/ucs/uc3/Ap2_pt3.png
diff --git a/docs/source/_static/img/ucs/uc3/Ap2_pt4.png b/docs/source/_static/img/ucs/uc3/Ap2_pt4.png
diff --git a/docs/source/_static/img/ucs/uc3/Ap2_pt5.png b/docs/source/_static/img/ucs/uc3/Ap2_pt5.png
diff --git a/docs/source/_static/img/ucs/uc3/FSP_example.PNG b/docs/source/_static/img/ucs/uc3/FSP_example.PNG
diff --git a/docs/source/_static/img/ucs/uc3/Install_pt1.png b/docs/source/_static/img/ucs/uc3/Install_pt1.png
diff --git a/docs/source/_static/img/ucs/uc3/Install_pt2.png b/docs/source/_static/img/ucs/uc3/Install_pt2.png
diff --git a/docs/source/_static/img/ucs/uc3/MODA.png b/docs/source/_static/img/ucs/uc3/MODA.png
diff --git a/docs/source/_static/img/ucs/uc3/Monolith_example.PNG b/docs/source/_static/img/ucs/uc3/Monolith_example.PNG
diff --git a/docs/source/_static/img/ucs/uc3/homescreen.png b/docs/source/_static/img/ucs/uc3/homescreen.png
diff --git a/docs/source/_static/img/ucs/uc3/schematic_of_system_implementation.png b/docs/source/_static/img/ucs/uc3/schematic_of_system_implementation.png
diff --git a/docs/source/_static/img/ucs/uc4/uc4_configuration.png b/docs/source/_static/img/ucs/uc4/uc4_configuration.png
diff --git a/docs/source/_static/img/ucs/uc4/uc4_download.png b/docs/source/_static/img/ucs/uc4/uc4_download.png
diff --git a/docs/source/_static/img/ucs/uc4/uc4_download_2.png b/docs/source/_static/img/ucs/uc4/uc4_download_2.png
diff --git a/docs/source/_static/img/ucs/uc4/uc4_index.png b/docs/source/_static/img/ucs/uc4/uc4_index.png
diff --git a/docs/source/_static/img/ucs/uc4/uc4_inprogress.png b/docs/source/_static/img/ucs/uc4/uc4_inprogress.png
diff --git a/docs/source/_static/img/ucs/uc4/uc4_process.png b/docs/source/_static/img/ucs/uc4/uc4_process.png
diff --git a/docs/source/_static/img/ucs/uc4/uc4_run_simulation.png b/docs/source/_static/img/ucs/uc4/uc4_run_simulation.png
diff --git a/docs/source/_static/img/ucs/uc4/uc4_standalone.png b/docs/source/_static/img/ucs/uc4/uc4_standalone.png
diff --git a/docs/source/_static/img/ucs/uc6/UC6_app.png b/docs/source/_static/img/ucs/uc6/UC6_app.png
diff --git a/docs/source/_static/img/ucs/uc_impl/RestAPI.png b/docs/source/_static/img/ucs/uc_impl/RestAPI.png
diff --git a/docs/source/_static/img/ucs/uc_impl/uc1.png b/docs/source/_static/img/ucs/uc_impl/uc1.png
diff --git a/docs/source/_static/img/ucs/uc_impl/uc2.png b/docs/source/_static/img/ucs/uc_impl/uc2.png
diff --git a/docs/source/_static/img/ucs/uc_impl/uc3.png b/docs/source/_static/img/ucs/uc_impl/uc3.png
diff --git a/docs/source/_static/img/ucs/uc_impl/uc4.png b/docs/source/_static/img/ucs/uc_impl/uc4.png
diff --git a/docs/source/_static/img/ucs/uc_impl/uc5.png b/docs/source/_static/img/ucs/uc_impl/uc5.png
diff --git a/docs/source/_static/img/ucs/uc_impl/uc6.png b/docs/source/_static/img/ucs/uc_impl/uc6.png
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -71,6 +71,15 @@ jupyter/hpc-sdk.ipynb
 apps/update
 ```
 
+```{toctree}
+:hidden: true
+:caption: App implementations
+:maxdepth: 2
+
+ucs/use_cases
+standalone_apps/standalone_apps
+```
+
 ```{toctree}
 :hidden: true
 :caption: Miscellaneous

diff --git a/docs/source/standalone_apps/chemical_balancer .md b/docs/source/standalone_apps/chemical_balancer .md
@@ -0,0 +1,27 @@
+# Standalone app: Chemical balancer
+
+## Description
+
+The chemical balancer app is a Python application that allows users to balance chemical reactions.
+This app takes unbalanced chemical equations as input and generates the corresponding balanced equation as output.
+
+## How to run the app
+
+### Inputs
+
+When you open the app you will be presented with the following screen
+
+![cb_app|200x100](../_static/img/standalone_apps/balancer_input.png)
+
+On this screen, you will find the necessary fields to input the chemical equation you wish to balance. The interface provides the following sections:
+
+- **Reactants**: Here, you can enter the chemical substances that act as the starting materials or reactants in the reaction. Simply input the relevant compounds or elements in this section.
+- **Products**: This section allows you to input the chemical substances that are formed as a result of the reaction. Enter the products of the reaction in this field.
+
+### Results
+
+After processing the input, the app will present you with the results. The output will be displayed as follows:
+![cb_app|200x100](../_static/img/standalone_apps/balancer_output.png)
+
+- **Original equation**:This field displays the chemical equation you initially inputted, showing the unbalanced form of the reaction.
+- **Balanced equation**:This field shows the balanced equation. The balanced equation accurately represents the stoichiometry of the reaction, with the appropriate coefficients for each compound or element.
diff --git a/docs/source/standalone_apps/hookes_law.md b/docs/source/standalone_apps/hookes_law.md
@@ -0,0 +1,23 @@
+# Standalone app: Hooke's Law
+
+## Description
+
+Hooke's Law app is a simple Python transformation application that allows users to compute Hooke's Law based on the stiffness constant and the displacement.
+
+This is the simplest of the standalone apps.
+
+## How to run the app
+
+### Inputs
+
+When you open the app you will be presented with the following screen
+
+![hookes_law|200x100](../_static/img/standalone_apps/hookes_law.png)
+
+Once both values have been inputted, the Force can be computed
+
+### Results
+
+The result is computed and shown in the same window, together with the transformation id:
+
+![hookes_law_output|200x100](../_static/img/standalone_apps/hookes_law_output.png)
diff --git a/docs/source/standalone_apps/laser_power.md b/docs/source/standalone_apps/laser_power.md
@@ -0,0 +1,36 @@
+# Standalone app: Laser power
+
+## Description
+
+The Laser power app is a Python application that calculates various laser power-related parameters based on user input. It allows users to provide input values for frequency, beam diameter, pulse energy, and pulse width, and then computes and displays the corresponding power and power density values. The app also provides a plot of the laser power profile over time.
+
+## How to run the app
+
+### Inputs
+
+When you open the app you will be presented with the following screen
+
+![laser_app|200x100](../_static/img/standalone_apps/laser_inputs.png)
+
+- **Frequency**: The frequency of the laser pulses.
+- **Beam Diameter**: The diameter of the laser beam.
+- **Pulse Energy**: The energy of each laser pulse.
+- **Pulse Width**: The duration of each laser pulse.
+
+### Results
+
+#### Text
+
+![laser_app|200x100](../_static/img/standalone_apps/text_outputs.png)
+
+- **Beam area**: Area covered by the beam
+- **Average Power**: Averaging the power over the course of one on/off cycle of the laser. This allows to determine the typical power output of the laser.
+- **Average Power Density**: Average power divided by the size of the beam's area. This parameter provides insights into the power concentration within the laser beam.
+- **Peak Power**: Energy of the laser pulse divided by the pulse width.
+- **Peak Power Density**: Peak power divided by the size of the beam's area. This parameter helps you understand the power concentration at the focal point or within a specific region of the laser beam.
+
+#### Image
+
+The app generates a diagram that illustrates the laser's power output over time. On the image a visual description of some quantities is reported
+
+![laser_app|200x100](../_static/img/standalone_apps/image_output.png)
diff --git a/docs/source/standalone_apps/standalone_apps.md b/docs/source/standalone_apps/standalone_apps.md
@@ -0,0 +1,20 @@
+# Standalone apps
+
+As additional work to the previous use cases, other more simple standalone apps have been developed.
+Their purpose is to demonstrate how apps can be developed and integrated in an easier way.
+
+- [Hooke's Law](hookes_law)
+- [Chemical balancer](chemical_balancer)
+- [Laser power](laser_power)
+- [Weld strength](weld_strength)
+
+```{toctree}
+:hidden: true
+:caption: Use Cases
+:maxdepth: 2
+
+hookes_law
+chemical_balancer
+laser_power
+weld_strength
+```
diff --git a/docs/source/standalone_apps/weld_strength.md b/docs/source/standalone_apps/weld_strength.md
@@ -0,0 +1,43 @@
+# Standalone app: Weld strength
+
+## Description
+
+This app calculates the strength of a weld based on user-provided parameters.
+The user selects the desired weld type, and the relevant parameters such as weld throat thickness and effective length.
+
+Depending on the selected weld type and load configuration, the function calculates and displays the corresponding stress values.
+
+For butt welds, it considers various load scenarios such as tensile, shear, bending, and twisting.
+For fillet welds, it calculates the strength based on different fillet weld configurations.
+
+## How to run the app
+
+### Inputs
+
+When you open the app you will be presented with the following screen
+
+![ws_app|200x100](../_static/img/standalone_apps/weld_input_1.png)
+
+You have to select the type of weld to calculate (butt weld or fillet weld), and you also have to provide the weld throat thickness and effective length of the weld.
+
+![ws_app|200x100](../_static/img/standalone_apps/weld_input_2.png)
+
+Here we select the butt weld, weld throat thickness of 2 mm and effective length of the weld of 2 mm.
+Once the butt weld type is selected you have to select a configuration to help you decide the app shows a image depicting the available possibilities.
+
+![ws_app|200x100](../_static/img/standalone_apps/weld_input_3.png)
+
+As an example let's select the twist case with a torque of 1000 N.
+
+At this point you only have to click on compute.
+
+### Results
+
+After processing the input, the app will present you with the results. The output will be displayed as follows:
+
+![ws_app|200x100](../_static/img/standalone_apps/weld_output_1.png)
+
+In this screen, you have a summary of your inputs together with the resulting stress.
+
+If in the previous section you had chosen to compute the stress for a fillet weld, this is the result page you would have had
+![ws_app|200x100](../_static/img/standalone_apps/weld_output_2.png)