Skip to content

Commit

Permalink
Merge pull request #91 from UM-Bridge/exahype-fix
Browse files Browse the repository at this point in the history
Update documentation for running ExaHyPE on ARM
  • Loading branch information
chun9l authored Jul 1, 2024
2 parents 49a7cb1 + 5302251 commit 1942b58
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ We begin by starting the tsunami model from the benchmark library. To make it mo

docker run -it -p 4242:4242 -v ~/tsunami_output:/output linusseelinger/model-exahype-tsunami

Replace the image name with ``model-exahype-tsunami-arm`` if you use an Arm-based machine.

Now the model is running, ready to be called by a client.

Calling the model from Python
Expand Down
4 changes: 2 additions & 2 deletions docs/source/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Setting up that simulation code on your system could easily take a day or two. T

As the tsunami model's documentation indicates, it is enough to run the following command to download and run its Docker image::

docker run -it -p 4242:4242 linusseelinger/model-exahype-tsunami
docker run -it -p 4242:4242 linusseelinger/model-exahype-tsunami # use model-exahype-tsunami-arm instead if you have an Arm machine

The model server is now up and running inside a container, waiting to be called by any UM-Bridge client. You can stop it by pressing Ctrl + C in its terminal.

Expand All @@ -117,7 +117,7 @@ Some models may output files in addition to the response the client receives; th

When launching the model, you can map this directory inside the container to ``~/tsunami_output`` on your machine::

docker run -it -p 4242:4242 -v ~/tsunami_output:/output linusseelinger/model-exahype-tsunami
docker run -it -p 4242:4242 -v ~/tsunami_output:/output linusseelinger/model-exahype-tsunami # model-exahype-tsunami-arm for Arm machines

* Optional: Request a model evaluation and pass ``{"vtk_output": True}`` as config. Then view the output files in your home directory under ``~/tsunami_output`` using ParaView or any other VTK visualization tool.

Expand Down

0 comments on commit 1942b58

Please sign in to comment.