Merge branch 'main' into develop

Author: xLPMG

README.rst

@@ -1,15 +1,18 @@
-###########
+#############
 Tsunami Lab
-###########
+#############
 
-This project was created as part of the Tsunami course in the winter semester 2023/24 at FSU Jena. 
-The lectures content was implemented by `Luca-Philipp Grumbach <https://github.com/xLPMG>`_ and `Richard Hofmann <https://github.com/ZeyxRew>`_ as weekly homework / exam assignments.
+The `tsunami lab <https://scalable.uni-jena.de/opt/tsunami/>`_ is a course taught at the `University of Jena <https://www.uni-jena.de/en/universityofjena>`_ as 
+the practical lab for the lecture on parallel computing.
+The goal is to write a C++ tsunami `wave equation <https://en.wikipedia.org/wiki/Wave_equation>`_ `solver <https://www.clawpack.org/riemann_book/html/Index.html>`_, optimize and parallelize it and run tsunami simulations on an `HPC cluster <https://wiki.uni-jena.de/pages/viewpage.action?pageId=22453005>`_.
 
-Further information is available from: https://scalable.uni-jena.de/opt/tsunami/
+During the class, we received weekly assignments which make up the final grade. Our (`Luca-Philipp Grumbach <https://github.com/xLPMG>`_ and `Richard Hofmann <https://github.com/ZeyxRew>`_)
+implementations of the given weekly tasks are what make up this repository - a fully functional 2D wave equation solver for Linux and MacOS.
 
 The documentation can be found here: https://xlpmg.github.io/tsunami_lab/index.html
 
-.. image:: docs/source/_static/assets/tohoku_example.png
-  :alt: Bathymetry of chile
+.. figure:: docs/source/_static/assets/tohoku_example.png
+    
+    Visualization of an OpenMP-parallelized tsunami simulation of the March 11, 2011 M 9.1 Tohoku event.
 
 

docs/source/files/assignments/project.rst

@@ -5,6 +5,8 @@
 In the project phase we decided to implement a user-friendly graphical user interface. The aim was to make the usage of our Tsunami solver
 as easy and interactive as possible. 
 
+All authors contributed in equal parts.
+
 *********************
 Preface
 *********************
@@ -76,7 +78,7 @@ In the last window, data files can be selected and then sent to the server. Rece
 Server-side
 *********************
 
-The first thing we did was to modularize our main ``tsunami_lab`` program. 
+The first task we had to tackle was to modularize our main ``tsunami_lab`` program. 
 
 The original ``main.cpp`` had one main function that executed the whole program loop.
 The code was moved to ``Simulator.cpp`` and we now have separate functions for the different parts of the program, such as ``prepareForCalculation()`` and ``runCalculation()``. 
@@ -102,7 +104,7 @@ Linux
 
 ``getCPUUsage()`` reads from ``/proc/stat`` and calculates the CPU usage based on the values in that file. 
 It provides us with info for each core on how much time it spent in different states (user, system, idle, etc.). 
-The time is measures in jiffies, which are typically 1/100th of a second. 
+The time is measured in jiffies, which are typically 1/100th of a second. 
 The server reads this file every 10 milliseconds and calculates the CPU usage based on the difference between the current and the last read.
 
 ``getRAMUsage()`` makes use of the ``sysinfo.h`` linux header file. It would've been possible to read from ``/proc/meminfo`` however we would have needed to parse the file and collect the correct value ourselves.
@@ -217,5 +219,4 @@ Communicator API
 Since all communication happens using text over TCP, we had to implement a structure that both server and client can adhere to
 in order to guarantee correct communication. For this, we decided to send all data in JSON format and a ``Message`` struct.
 
-
-.. note:: For further information, see :ref:`ns-lib`
+.. note:: For further information, see :ref:`ns-lib`

src/Server.cpp

@@ -8,31 +8,31 @@
 #include <atomic>
 using json = nlohmann::json;
 
-//! port for the server
+//! Port for the server
 int m_PORT = 8080;
-//! exit flag
+//! Exit flag
 bool m_EXIT = false;
-//! simulator object pointer
+//! Simulator object pointer
 tsunami_lab::Simulator *simulator = nullptr;
-//! thread object while will be used to run simulation tasks
+//! Thread object which will be used to run simulation tasks
 std::thread m_simulationThread;
-//! thread object which will be used to update system info
+//! Thread object which will be used to update system info
 std::thread m_updateThread;
-//! flag to stop updating
+//! Flag to stop updating
 std::atomic<bool> m_stopUpdating = false;
-//! flag to check if simulation is running
+//! Flag to check if simulation is running
 bool m_isSimulationRunning = false;
 
-//! last update time point
+//! Last update time point
 std::chrono::time_point m_lastDataUpdate = std::chrono::high_resolution_clock::now();
-//! data update frequency in ms
+//! Lata update frequency in ms
 int m_dataUpdateFrequency = 10;
 
-//! system info object
+//! System info object
 tsunami_lab::systeminfo::SystemInfo l_systemInfo;
-//! amount of used RAM
+//! Amount of used RAM
 double l_usedRAM = 0;
-//! total amount of RAM
+//! Total amount of RAM
 double l_totalRAM = 0;
 //! CPU usage vector
 std::vector<float> l_cpuUsage;
@@ -578,4 +578,4 @@ int main(int i_argc, char *i_argv[])
 
     delete simulator;
     return exitCode;
-}
+}