diff --git a/docs/assets/into-cps-logo.png b/docs/assets/into-cps-logo.png index dfc81fe0f..ca04a29f4 100644 Binary files a/docs/assets/into-cps-logo.png and b/docs/assets/into-cps-logo.png differ diff --git a/docs/assets/into-cps-logo.svg b/docs/assets/into-cps-logo.svg new file mode 100755 index 000000000..c37b7785f --- /dev/null +++ b/docs/assets/into-cps-logo.svg @@ -0,0 +1,214 @@ + + + +image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + INTO-CPS + + + + \ No newline at end of file diff --git a/examples/cosimconfig.png b/docs/user/examples/cosimconfig.png similarity index 100% rename from examples/cosimconfig.png rename to docs/user/examples/cosimconfig.png diff --git a/docs/user/examples/index.md b/docs/user/examples/index.md index b2b6afad2..61ca27ed4 100644 --- a/docs/user/examples/index.md +++ b/docs/user/examples/index.md @@ -1,4 +1,17 @@ -# DTaaS examples +# DTaaS Examples + +## Code setup + +Pull all the code for all examples simply by executing the script below: + +```bash +#!/bin/bash +cd /root/Desktop/ +wget -P workspace https://github.com/INTO-CPS-Association/DTaaS-examples/archive/refs/heads/main.zip +unzip workspace/main.zip -d workspace +mv workspace/DTaaS-examples-main workspace/examples +rm workspace/main.zip +``` + +The code for all examples is now setup in the workspace/examples folder and is ready for creation and execution. -The examples are hosted in -[DTaaS examples repository](https://github.com/INTO-CPS-Association/DTaaS-examples) diff --git a/examples/mass-spring-damper_multibody_system.png b/docs/user/examples/mass-spring-damper_multibody_system.png similarity index 100% rename from examples/mass-spring-damper_multibody_system.png rename to docs/user/examples/mass-spring-damper_multibody_system.png diff --git a/examples/mass_spring_damper.md b/docs/user/examples/mass_spring_damper.md similarity index 67% rename from examples/mass_spring_damper.md rename to docs/user/examples/mass_spring_damper.md index 42efa5606..187f2addb 100644 --- a/examples/mass_spring_damper.md +++ b/docs/user/examples/mass_spring_damper.md @@ -10,19 +10,25 @@ The mass spring damper study comprises two mass spring dampers and demonstrates # Example Structure -There are two simulators included in the study, each representing a mass spring damper system. The first simulator calculates the mass displacement and speed of *m1* for a given force *Fk* acting on mass *m1*. The second simulator calculates force *Fk* given a displacement and speed of mass *m1*. By coupling these simulators, the evolution of the position of the two masses is computed. +There are two simulators included in the study, each representing a mass spring damper system. The first simulator calculates the mass displacement and speed of $m_1$ for a given force $F_k$ acting on mass $m_1$. The second simulator calculates force $F_k$ given a displacement and speed of mass $m_1$. By coupling these simulators, the evolution of the position of the two masses is computed. ![Mass Spring Damper Structure](mass_spring_structure.png) ## Configuration of assets -![Configuration](cosimconfig.png) +This example uses two models and one tool. The specific assets used are: + +| Asset Type | Names of Assets | Visibility | Reuse in Other Examples | +|:---|:---|:---|:---| +| Models | MassSpringDamper1.fmu | Private | Yes | +| | MassSpringDamper2.fmu | Private | Yes | +| Tool | maestro-2.3.0-jar-with-dependencies.jar | Common | Yes | ## Lifecycle Phases | Lifecycle Phase | Completed Tasks | | -------- | ------- | -| Create | Installs JDK | +| Create | Installs Java Development Kit for Maestro tool | | Execute | Produces and stores output in data/mass-spring-damper/output directory| | Clean | Clears run logs and outputs | @@ -56,7 +62,7 @@ lifecycle/execute ## Examine the results -The results can be found in the _workspace/examples/data/mass-spring-damper/output directory_. +The results can be found in the _workspace/examples/data/mass-spring-damper/output directory_. You can also view run logs in the _workspace/examples/digital_twins/mass-spring-damper_. \ No newline at end of file diff --git a/examples/mass_spring_structure.png b/docs/user/examples/mass_spring_structure.png similarity index 100% rename from examples/mass_spring_structure.png rename to docs/user/examples/mass_spring_structure.png diff --git a/examples/index.md b/examples/index.md deleted file mode 100644 index 61ca27ed4..000000000 --- a/examples/index.md +++ /dev/null @@ -1,17 +0,0 @@ -# DTaaS Examples - -## Code setup - -Pull all the code for all examples simply by executing the script below: - -```bash -#!/bin/bash -cd /root/Desktop/ -wget -P workspace https://github.com/INTO-CPS-Association/DTaaS-examples/archive/refs/heads/main.zip -unzip workspace/main.zip -d workspace -mv workspace/DTaaS-examples-main workspace/examples -rm workspace/main.zip -``` - -The code for all examples is now setup in the workspace/examples folder and is ready for creation and execution. - diff --git a/mkdocs.yml b/mkdocs.yml index 072c4cd8f..62673bba0 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -39,7 +39,10 @@ nav: - Digital Twins: - Create: user/digital-twins/create.md - Lifecycle: user/digital-twins/lifecycle.md - - Examples: https://github.com/INTO-CPS-Association/DTaaS-examples + - Examples: + - Overview: user/examples/index.md + - Mass Spring Damper: user/examples/mass_spring_damper.md + - Codebase: https://github.com/INTO-CPS-Association/DTaaS-examples - FAQ: FAQ.md - Developer: - Overview: developer/index.md @@ -61,7 +64,9 @@ extra_css: extra_javascript: - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML - + - https://polyfill.io/v3/polyfill.min.js?features=es6 + - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js + markdown_extensions: - attr_list - pymdownx.emoji: