From a337336fc0e5c9d0efcd1bd53b45f9687efc4503 Mon Sep 17 00:00:00 2001 From: bertrand <cirou@cines.fr> Date: Fri, 4 Oct 2024 16:01:46 +0200 Subject: [PATCH 1/3] few lines --- ExaDigiTUE5.rst | 33 +++++++++++++++++++++++++++++++++ index.rst | 2 +- unrealUE5.rst | 5 ----- 3 files changed, 34 insertions(+), 6 deletions(-) create mode 100644 ExaDigiTUE5.rst delete mode 100644 unrealUE5.rst diff --git a/ExaDigiTUE5.rst b/ExaDigiTUE5.rst new file mode 100644 index 0000000..67db514 --- /dev/null +++ b/ExaDigiTUE5.rst @@ -0,0 +1,33 @@ +ExaDigiTUE5 Documentation +================================ + +ExaDigiTUE5 is provides the AR/VR interface to ORNL's exascale digital twin. +The main functionality is implemented using Unreal Engine 5.1 for Desktop or +Microsoft Hololens2 based visualization and interation with the system. +The digital twin provides data ingestion from telemetry, as well as triggering +and interacting with simulations developed for the wider ExaDigiT project at +ORNL, as well as for the LUMI system at CSC and other CrayEX Supercomputers. +For the overarching project, see ExaDigiT at https://exadigit.github.io, +with the code repositories at https://code.ornl.gov/exadigit. + + +Installation +------------ + +First install Unreal Engine 5.1. +To be part of the EpicGames Organization and have access to https://github.com/EpicGames/UnrealEngine/tree/5.1 watch the video https://www.youtube.com/watch?v=rldy9yY0yDU or through https://www.unrealengine.com/en-US/download + + + +git clone --recurse-submodules https://code.ornl.gov/exadigit/exadigitue5.git + +For UEFMI, which is a plugin to the project follow the installation guide at +https://github.com/ORNL-Modelica/UnrealEngine-FMIPlugin +Especially its contained submodules and fmikit setup! (See README.md#Installation of the project.) + + +Contributors +------------ + +Matthias Maiterth, Dane de Wet, Jesse Hines, Scott Greenwood, Sedrick Bouknight + diff --git a/index.rst b/index.rst index bf08057..5e1d60b 100644 --- a/index.rst +++ b/index.rst @@ -9,7 +9,7 @@ Welcome to ExaDigiT's documentation! .. toctree:: :maxdepth: 2 - unrealUE5 + ExaDigiTUE5 coolingModel NetworkDT RAPS diff --git a/unrealUE5.rst b/unrealUE5.rst deleted file mode 100644 index ff7e23b..0000000 --- a/unrealUE5.rst +++ /dev/null @@ -1,5 +0,0 @@ -UnrealUE5 Documentation -================================ - -This section covers documentation for the ExaDigiT/UnrealUE5 project. -Details will be added as the project develops. -- GitLab From 54a675a9721adaace9ba4bf8566bceddf4f3474d Mon Sep 17 00:00:00 2001 From: bertrand <cirou@cines.fr> Date: Wed, 16 Oct 2024 11:56:22 +0200 Subject: [PATCH 2/3] addpicture --- ExaDigiTUE5.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/ExaDigiTUE5.rst b/ExaDigiTUE5.rst index 67db514..5279be8 100644 --- a/ExaDigiTUE5.rst +++ b/ExaDigiTUE5.rst @@ -1,7 +1,7 @@ ExaDigiTUE5 Documentation ================================ -ExaDigiTUE5 is provides the AR/VR interface to ORNL's exascale digital twin. +ExaDigiTUE5 provides the AR/VR interface to ORNL's exascale digital twin. The main functionality is implemented using Unreal Engine 5.1 for Desktop or Microsoft Hololens2 based visualization and interation with the system. The digital twin provides data ingestion from telemetry, as well as triggering @@ -25,7 +25,14 @@ For UEFMI, which is a plugin to the project follow the installation guide at https://github.com/ORNL-Modelica/UnrealEngine-FMIPlugin Especially its contained submodules and fmikit setup! (See README.md#Installation of the project.) +Visualisation +------------- +.. figure:: ExaDigiTUE5/pictures/ExadigitUE5-Frontier-VR1.JPG + :align: center + :width: 50% + :alt: Frontier VR view with ExaDigiTUE5 + Contributors ------------ -- GitLab From 480c3ad884bb0acb1519e6c6430fdc250b5c9cd1 Mon Sep 17 00:00:00 2001 From: bertrand <cirou@cines.fr> Date: Wed, 23 Oct 2024 11:08:22 +0200 Subject: [PATCH 3/3] enhance structure of doc --- ExaDigiTUE5.rst | 2 +- NetworkDT.rst | 4 ++-- RAPS.rst | 2 +- coolingModel.rst | 2 +- index.rst | 23 ++++++++--------------- 5 files changed, 13 insertions(+), 20 deletions(-) diff --git a/ExaDigiTUE5.rst b/ExaDigiTUE5.rst index 5279be8..c54eb0c 100644 --- a/ExaDigiTUE5.rst +++ b/ExaDigiTUE5.rst @@ -1,4 +1,4 @@ -ExaDigiTUE5 Documentation +ExaDigiTUE5 ================================ ExaDigiTUE5 provides the AR/VR interface to ORNL's exascale digital twin. diff --git a/NetworkDT.rst b/NetworkDT.rst index a761395..a4b3c72 100644 --- a/NetworkDT.rst +++ b/NetworkDT.rst @@ -1,5 +1,5 @@ -NetworkDT Documentation -================================ +NetworkDT Digital Twin for network power and congestion +======================================================= This section covers documentation for the ExaDigiT/NetworkDT project. Details will be added as the project develops. diff --git a/RAPS.rst b/RAPS.rst index 332b871..3db0436 100644 --- a/RAPS.rst +++ b/RAPS.rst @@ -1,4 +1,4 @@ -Resource Allocator and Power Simulator (RAPS) documentation +Resource Allocator and Power Simulator (RAPS) =========================================================== RAPS is one of the modules used by the ExaDigiT framework. diff --git a/coolingModel.rst b/coolingModel.rst index ec91161..1886683 100644 --- a/coolingModel.rst +++ b/coolingModel.rst @@ -1,4 +1,4 @@ -CoolingModel Documentation +CoolingModel =================================== This section covers documentation for the ExaDigiT/coolingModel project. diff --git a/index.rst b/index.rst index ac048ab..b82a42b 100644 --- a/index.rst +++ b/index.rst @@ -6,7 +6,7 @@ .. figure:: ExaDigiTUE5/pictures/FrontierDigitalTwin.JPG :align: center - :width: 50% + :width: 100% :alt: Frontier digital twin view @@ -16,35 +16,28 @@ ExaDigiT documentation ExaDigiT is a digital twin of supercomputers and their thermal infrastructures. It offers insights into operational strategies, "what-if" scenarios, as well as elucidates complex, cross-disciplinary transient behaviors. It also serves as a design tool for future system prototyping. It combines telemetry and simulations, providing a virtual representation of physical systems. It supports planning, construction, and operations, offering value in decision-making, predictive maintenance, and system efficiency. In design stages, it can evaluate energy efficiency, virtually prototype cooling systems, and model network performance. During operations, ExaDigiT aids in predictive maintenance and operational optimization. -ExaDigiT is built on an open software stack (Modelica, SST Macro, Unreal Engine) with an aim to foster community-driven development, we have formed a partnership with national supercomputer centers (ORNL, LLNL, LANL (USA), PAWSEY (Australia), LUMI (Finland), CINES/GENCI (France) , CINECA (Italy), ...) around the world to develop an open framework for modeling supercomputers. +ExaDigiT is built on an open software stack (Modelica, SST Macro, Unreal Engine) with an aim to foster community-driven development, we have formed a partnership with national supercomputer centers (ORNL, LLNL, LANL (USA), PAWSEY (Australia), LUMI (Finland), CINES (France) , CINECA (Italy), ...) around the world to develop an open framework for modeling supercomputers. ExaDigiT uses four primary components: --------------------------------------- - - RAPS: resource allocator and power simulator to model workloads, energy usage, and energy conversion losses. + - **RAPS**: Resource Allocator and Power Simulator (https://code.ornl.gov/exadigit/raps) to model workloads, energy usage, and energy conversion losses. - - Modelica FMU (AutoCSM https://code.ornl.gov/exadigit/AutoCSM, LBNL https://github.com/lbl-srg/modelica-buildingsL, TRANSFORM https://github.com/ORNL-Modelica/TRANSFORM-Library) transient thermo-fluid simulation to model the cooling system from the cooling tower to the cold plate. + - **Modelica FMU** (AutoCSM https://code.ornl.gov/exadigit/AutoCSM, LBNL https://github.com/lbl-srg/modelica-buildingsL, TRANSFORM https://github.com/ORNL-Modelica/TRANSFORM-Library) transient thermo-fluid simulation to model the cooling system from the cooling tower to the cold plate. - A network digital twin to simulate network power and congestion. - - ExaDigiTUE5: A visual analytics module using Unreal Engine 5 for augmented reality and a web-based dashboard for experiments. + - **ExaDigiTUE5**: A visual analytics module (https://code.ornl.gov/exadigit/exadigitue5) using Unreal Engine 5 for augmented reality and a web-based dashboard for experiments. - .. toctree:: :maxdepth: 2 + :hidden: - ExaDigiTUE5 + RAPS coolingModel NetworkDT - RAPS - - + ExaDigiTUE5 -Indices and tables -================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` -- GitLab