Skip to content

Commit

Permalink
Fixes writing mistakes and rearranges docs menu
Browse files Browse the repository at this point in the history
  • Loading branch information
@prasadtalasila
prasadtalasila committed Jun 18, 2024
1 parent 9c739f3 commit 85acd04
Show file tree
Hide file tree
Showing 6 changed files with 138 additions and 152 deletions.
125 changes: 59 additions & 66 deletions docs/FAQ.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,55 +22,67 @@

1. DTaaS is a web based interface to allow you to invoke various tools
related to work you want to perform with one or more DTs.
2. DTaaS as such doesn't help you create DTs; it loads and runs DTs
that you create using tools and services that are available via DTaaS.
3. DTaaS can help you create DTs only if your DT or DT asset authoring tools
can work in user workspace containing
Linux terminal / Desktop / Jupyter / VSCode services.
4. DTaaS as such won't help you to install DTs that you get from elsewhere.
5. DTs are just executables, as far as DTaaS is concerned.
1. DTaaS permits users to run DTs in their private workspaces.
These user workspaces are based on Ubuntu 20.04
Operating system.
1. DTaaS can help you create reusable DT assets only if DT
asset authoring tools
can work in Ubuntu 20.04 xfce desktop environment.
1. DTs are just executables, as far as DTaaS is concerned.
Users are not constrained to work with DTs in a certain way.
The DTaaS suggests creation of DTs from reusable assets and provides
a suggestive structure for DTs. The [examples](./user/examples/index.md)
provide more insight into DTaaS way of working with DTs.
But this suggested workflow is not binding on the users.
6. DTaaS doesn't help you to autorun run DTs, other than by providing
user workspaces. These user workspaces are based on Ubuntu 20.04
Operating system.
7. The current user interface of DTaaS web application is heavily reliant
1. DTs can be run as services with REST API from within user workspace
which can help with service-level DT composition.

??? Question "What can not be done inside DTaaS?"

1. DTaaS as such won't help you to install DTs that you get from elsewhere.
1. The current user interface of DTaaS web application is heavily reliant
on the use of Jupyter lab and notebook.
The **Digital Twins** page has Create / Execute / Analyze sections but
all point to Jupyter lab. Web interface. The functionality of these pages
is still under development.
1. DTaaS does not yet have DevOps like automation capabilities.

??? Question "Is there any fundamental difference between commercial solutions like Ansys Twin Builder and DTaaS?"

??? Question "Are there any Key Performance / Capability Indicators for DTaaS?"

| Key Performance Indicator | Value |
|:---|:---|
| Processor | Two AMD EPYC 7443 24-Core Processors |
| Maximum Storage Capacity | 4TB SSD, RAID 0 configuration |
| Storage Type | File System |
| Maximum file size | 10 GB |
| Data transfer speed | 100 Mbps |
| Data Security | Yes |
| Data Privacy | Yes |
| Redundancy | None |
| Availability | It is a matter of human resources. If you have human
resources to maintain DTaaS round the clock,
upwards 95% is easily possible. |
Commercial DT platforms like _Ansys Twin Builder_ provide tight integration
between models, simulation and sensors. This leads to fewer choices in
DT design and implementation. In addition, there is a limitation of vendor lockin.
On the other hand, DTaas lets users separate DT into reusable assets
and combine these assets in a flexible way.

??? Question "Do you provide licensed software like Matlab?"

The licensed software are not available on the software platform.
Proprietary and commercially licensed software is not
available by default on the software platform.
But users have private workspaces which are based
on Linux-based xfce Desktop environment.
Users can install software in their workspaces.
Please see a
Users can install proprietary and commercially licensed
software in their workspaces. Please see a
[screencast](FAQ/matlab-simulink.mp4) of using Matlab Simulink
within the DTaaS software.
The licensed software installed by one user is not available
to another user.

## Digital Twin Assets

??? Question "Can DTaaS be used to create new DT assets?"

The core feature of DTaaS software is to help users
create DTs from assets already available in the library.
![Create Library Assets](./user/servers/lib/author.png)
However, it is possible for users to take advantage of services
available in their workspace to install asset authoring tools
in their own workspace.
These authoring tools can then be used to create and publish new assets.
User workspaces are private and are not shared with other users.
Thus any licensed software tools installed in their workspace is
only available to them.

## Digital Twin Models

??? Question "Can DTaaS create new DT models?"
Expand All @@ -94,10 +106,6 @@
For example, if you need Matlab for your work, you need to bring
he licensed Matlab software.

??? Question "Commercial DT platforms in market provide modelling and simulation alongside integration and UI. DTaas is not able to do any modelling or simulation on its own like other commercial platforms. Is this a correct understanding?"

Yes, you are right

??? Question "Can DTaaS support only the information models (or behavioral models) or some other kind of models?"

The DTaaS as such is agnostic to the kind of models you use. DTaaS can
Expand All @@ -119,6 +127,16 @@

## Communication Between Physical Twin and Digital Twin

??? Question "How can DTaaS control the physical entity? Which technologies it uses for controlling the physical world?"

At a very abstract level, there is a communication from physical entity
to digital entity and back to physical entity. How this communication
should happen is decided by the person designing the digital entity.
The DTaaS can provide communication services that can help you do this
communication with relative ease.
You can use InfluxDB, RabbitMQ and Mosquitto services hosted on DTaaS for
two communication between digital and physical entities.

??? Question "How would you measure a physical entity like shape, size, weight, structure, chemical attributes etc. using DTaaS? Any specific technology used in this case?"

The real measurements are done at physical twin which are then
Expand All @@ -130,7 +148,7 @@
Having said that, DTaaS allows you to utilize other communication
technologies and services hosted elsewhere on the Internet.

??? Question "How a real-time data can be differed from static data and what is the procedure to identify dynamic data? Is there any UI or specific tool used here?"
??? Question "How can real-time data differ from static data and what is the procedure to identify dynamic data? Is there any UI or specific tool used here?"

DTaaS can not understand the static or dynamic nature of data.
It can facilitate storing names, units and any other text description
Expand All @@ -149,17 +167,11 @@
a Linux desktop / commandline, the tool can be supported within DTaaS.
The tool (ex. Matlab) itself can take care of the metadata requirements.

??? Question "How can DTaaS control the physical entity? Which technologies it uses for controlling the physical world?"
## Data Management

At a very abstract level, there is a communication from physical entity
to digital entity and back to physical entity. How this communication
should happen is decided by the person designing the digital entity.
The DTaaS can provide communication services that can help you do this
communication with relative ease.
You can use InfluxDB, RabbitMQ and Mosquitto services hosted on DTaaS for
two communication between digital and physical entities.
??? Question "Can DTaaS collect data directly from sensors?"

## Data Management
Yes via platform services.

??? Question "Does DTaaS support data collection from different sources like hardware, software and network? Is there any user interface or any tracking instruments used for data collection?"

Expand All @@ -171,6 +183,10 @@
used to analyze the data collected.
Users can also manually upload their data files into DTaaS.

??? Question "Is DTaaS able to transmit data to cloud in real time?"

Yes via platform services.

??? Question "Which transmission protocol does DTaaS allow?"

InfluxDB, RabbitMQ, MQTT and anything else that can be used from
Expand All @@ -188,14 +204,6 @@
for the visualization, you will have to bring the license for it.
DTaaS does not support AR/VR.

??? Question "Can DTaaS collect data directly from sensors?"

Yes

??? Question "Is DTaaS able to transmit data to cloud in real time?"

Yes

## Platform Native Services on DTaaS Platform

??? Question "Is DTaaS able to detect the anomalies about-to-fail components and prescribe solutions?"
Expand Down Expand Up @@ -240,21 +248,6 @@
that GE Predix natively provides in one interface.
The takeaway is that we pick horses for the courses.

## Create Assets

??? Question "Can DTaaS be used to create new DT assets?"

The core feature of DTaaS software is to help users
create DTs from assets already available in the library.
![Create Library Assets](./user/servers/lib/author.png)
However, it is possible for users to take advantage of services
available in their workspace to install asset authoring tools
in their own workspace.
These authoring tools can then be used to create and publish new assets.
User workspaces are private and are not shared with other users.
Thus any licensed software tools installed in their workspace is
only available to them.

## GDPR Concerns

??? Question "Does your platform adhere to GDPR compliance standards? If so, how?"
Expand Down
8 changes: 6 additions & 2 deletions docs/bugs.md
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# Few issues in the Software

If you find a bug, please
[open an issue](https://github.com/INTO-CPS-Association/DTaaS/issues/new)

## Third-Party Software

- We use third-party software which have certain
known issues. Some of the issues are listed below.
The explanation given below corresponds to the bugs you may face
from third party software included in DTaaS.
Known issues are listed below.

### ML Workspace

Expand Down
6 changes: 4 additions & 2 deletions docs/developer/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Developers Guide

This guide is to help developers get familiar with the project. Please see
developer-specific
This guide is for DTaaS platform developers.
It helps development team members get familiar with
the DTaaS project software design, and development processes.
Please see developer-specific
[Slides](https://odin.cps.digit.au.dk/into-cps/dtaas/assets/DTaaS-developer-overview_march2024.pdf),
[Video](https://odin.cps.digit.au.dk/into-cps/dtaas/assets/videos/DTaaS-developer-overview_march2024.mp4),
and [Research paper](https://arxiv.org/abs/2305.07244).
Expand Down
29 changes: 9 additions & 20 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,30 +1,19 @@
# What is DTaaS?

<!-- markdownlint-disable MD046 -->
<!-- prettier-ignore -->
!!! failure
Please note that the development documentation is being
rewritten heavily. This rework is being done to prepare
the documentation for the next release. Please use
[DTaaS v0.4](https://into-cps-association.github.io/DTaaS/version0.4/index.html)
for installation and use. Thank you.
<!-- markdownlint-enable MD046 -->

The Digital Twin as a Service (DTaaS) software platform is useful
to <font color="orange"> **Build, Use and Share** </font> digital twins (DTs).

:mechanical_arm: <font color="orange">**Build**</font>: The
DTs are built on the software platform
using the reusable DT components available on the platform.
:mechanical_arm: <font color="orange">**Build**</font>: DTs are built on DTaaS using
reusable DT assets available on the platform.

:office_worker: :factory_worker: <font color="orange">**Use**</font>: Use
the DTs on the software platform.
:office_worker: :factory_worker: <font color="orange">**Use**</font>: Run your
DTs on DTaaS.

:handshake: <font color="orange">**Share**</font>: Share ready to use DTs
with other users.
It is also possible to share the services offered by one DT with other users.
:handshake: <font color="orange">**Share**</font>: Share ready-to-use DTs
with other users. It is also possible to share the services
offered by one DT with other users.

There is an overview of the software available in the form of
There is an overview of DTaaS available in the form of
[slides](https://odin.cps.digit.au.dk/into-cps/dtaas/assets/DTaaS-short-intro_jan2024.pdf),
[video](https://odin.cps.digit.au.dk/into-cps/dtaas/assets/videos/DTaaS-short-intro_jan2024.mp4),
and [feature walkthrough](https://odin.cps.digit.au.dk/into-cps/dtaas/assets/videos/dtaas-v0.4-demo.mp4).
Expand All @@ -35,6 +24,6 @@ This software is owned by
[The INTO-CPS Association](https://into-cps.org/)
and is available under [the INTO-CPS License](LICENSE.md).

The DTaaS software platform uses [third-party](./third-party.md)
DTaaS software platform uses [third-party](./third-party.md)
open-source software.
These software components have their own licenses.
61 changes: 30 additions & 31 deletions mkdocs-github.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,37 @@ theme:

nav:
- Home: index.md
- User:
- Motivation: user/motivation.md
- Features: user/features.md
- Website: user/website/index.md
- Reusable Assets:
- Concept: user/servers/lib/assets.md
- Microservice: user/servers/lib/LIB-MS.md
- Digital Twins:
- Create: user/digital-twins/create.md
- Lifecycle: user/digital-twins/lifecycle.md
- Runner: user/servers/execution/runner/README.md
- Examples:
- Overview: user/examples/index.md
- Mass Spring Damper: user/examples/mass-spring-damper/README.md
- Water Tank Fault Injection: user/examples/water_tank_FI/README.md
- Water Tank Model Swap: user/examples/water_tank_swap/README.md
- Desktop Robotti and RabbitMQ: user/examples/drobotti-rmqfmu/README.md
- Water Plant and OPC-UA: user/examples/opc-ua-waterplant/README.md
- Three Water Tanks: user/examples/three-tank/README.md
- Flex Cell: user/examples/flex-cell/README.md
- Incubator: user/examples/incubator/README.md
- Firefighters: user/examples/o5g/README.md
- Mass Spring Damper with NuRV: user/examples/mass-spring-damper-monitor/README.md
- Incubator with NuRV: user/examples/incubator-NuRV-monitor-validation/README.md
- Incubator with NuRV Service: user/examples/incubator-NuRV-monitor-service/README.md
- Water Tank Fault Injection with NuRV: user/examples/water_tank_FI_monitor/README.md
- Codebase: https://github.com/INTO-CPS-Association/DTaaS-examples
- Admin:
- Overview: admin/overview.md
- Install:
- Steps: admin/steps.md
- Installation Scenarios: admin/overview.md
- Installation Steps: admin/steps.md
- Requirements: admin/requirements.md
- Authorization:
- Client: admin/client/auth.md
Expand All @@ -41,7 +68,6 @@ nav:
- Library Microservice:
- NPM: admin/servers/lib/npm.md
- Docker: admin/servers/lib/docker.md
- Runner: user/servers/execution/runner/README.md
- Guides:
- Add user: admin/guides/add_user.md
- Remove user: admin/guides/remove_user.md
Expand All @@ -50,36 +76,9 @@ nav:
- Link services: admin/guides/link_service.md
- Common Assets: admin/guides/common_workspace_readonly.md
- HTTP Mode: admin/guides/hosting_site_without_https.md
- User:
- Motivation: user/motivation.md
- Features: user/features.md
- Website: user/website/index.md
- Library:
- Assets: user/servers/lib/assets.md
- Microservice: user/servers/lib/LIB-MS.md
- Digital Twins:
- Create: user/digital-twins/create.md
- Lifecycle: user/digital-twins/lifecycle.md
- Runner: user/servers/execution/runner/README.md
- Examples:
- Overview: user/examples/index.md
- Mass Spring Damper: user/examples/mass-spring-damper/README.md
- Water Tank Fault Injection: user/examples/water_tank_FI/README.md
- Water Tank Model Swap: user/examples/water_tank_swap/README.md
- Desktop Robotti and RabbitMQ: user/examples/drobotti-rmqfmu/README.md
- Water Plant and OPC-UA: user/examples/opc-ua-waterplant/README.md
- Three Water Tanks: user/examples/three-tank/README.md
- Flex Cell: user/examples/flex-cell/README.md
- Incubator: user/examples/incubator/README.md
- Firefighters: user/examples/o5g/README.md
- Mass Spring Damper with NuRV: user/examples/mass-spring-damper-monitor/README.md
- Incubator with NuRV: user/examples/incubator-NuRV-monitor-validation/README.md
- Incubator with NuRV Service: user/examples/incubator-NuRV-monitor-service/README.md
- Water Tank Fault Injection with NuRV: user/examples/water_tank_FI_monitor/README.md
- Codebase: https://github.com/INTO-CPS-Association/DTaaS-examples
- FAQ: FAQ.md
- Developer:
- Overview: developer/index.md
- Developer Guide: developer/index.md
- System:
- Architecture: developer/system/architecture.md
- Current Status: developer/system/current-status.md
Expand Down
Loading

0 comments on commit 85acd04

Please sign in to comment.