Skip to content

Commit

Permalink
finishing touches
Browse files Browse the repository at this point in the history
  • Loading branch information
xLPMG committed Feb 11, 2024
1 parent 8dde0b2 commit 3642a4d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 10 deletions.
5 changes: 2 additions & 3 deletions docs/source/files/assignments/project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
10. Project Phase
###################

In the project phase we decided to implement a user-friendly Gui. The aim was to make the usage of our Tsunami solver
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.

*********************
Expand Down Expand Up @@ -30,7 +30,7 @@ All it takes is to send the correct commands to the server by sticking to the AP
GUI (Client-side)
*********************

The Gui is desigend to be as intuitively usable as possible. Therefore, we divided the functionality of the GUI into 5 sections, which are represented by the main tabs.
We divided all functionality into 5 sections, which are represented by the main tabs.

.. image:: ../../_static/assets/task-10-Gui_help.png

Expand Down Expand Up @@ -72,7 +72,6 @@ The system info vizualization shows usaga of the RAM during computation.

In the last window, data files can be selected and then sent to the server. Receiving from the server is possible as well.


*********************
Server-side
*********************
Expand Down
12 changes: 5 additions & 7 deletions docs/source/files/categories/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Navigate to the local git repository. If the name wasnt explicitly changed, this
If you have yet to set up and build the git repository locally, check out the :ref:`setup` page first.


Running with GUI
Running with the GUI
----------------------

.. note::
Expand All @@ -26,17 +26,15 @@ inside the ``tsunami_lab`` folder. To start the server, run
./build/tsunami_lab server <PORT>
also from inside the ``tsunami_lab`` folder. The ``<PORT>`` parameter specifies which port will be used for the remote connection.
If no port is specified, ``8080`` will be used.

The two applications may run on different machines, but you have to make sure that the server can be reached over TCP using
the machines ip address and the specified port.

How to use the GUI
---------------------

This part of the usage documentation was moved to its own :ref:`separate page <gui-doc>`.
For instructions on how to use the GUI, check out :ref:`this page <gui-doc>`.

Running without GUI
----------------------
Running without the GUI
-------------------------

Make sure you are inside the ``tsunami_lab`` folder.
To run the simulator, execute
Expand Down

0 comments on commit 3642a4d

Please sign in to comment.