From c3722b37bde92cce67a8a67a17d6ecf45d5d9226 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miikka=20V=C3=A4is=C3=A4l=C3=A4?= Date: Mon, 17 Jun 2019 10:32:14 +0000 Subject: [PATCH] Corrected typos Because of course. --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d76c2af..60974b8 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ NVIDIA GPU with >= 3.0 compute capability. See https://en.wikipedia.org/wiki/CUD ## Building -There are two ways to build the code instructed below. +There are two ways to build the code as instructed below. If you encounter issues, recheck that the 3rd party libraries were successfully built during the previous step. @@ -28,9 +28,9 @@ If you encounter issues, recheck that the 3rd party libraries were successfully Edit `config/astaroth.conf` to change the numerical setup. -### Method II: With script to a custom build directory +### Method II: With a script in a custom build directory (RECOMMENDED) -1. `source sourceme.sh` to all relevant directories to the `PATH` +1. `source sourceme.sh` to add relevant directories to the `PATH` 1. `ac_mkbuilddir.sh -b my_build_dir/` to set up a custom build directory. There are also other options available. See `ac_mkbuilddir.sh -h` for more. 1. `$AC_HOME/scripts/compile_acc.sh` to generate kernels from the Domain Specific Language 1. `cd my_build_dir/` @@ -47,6 +47,10 @@ Edit `my_build_dir/astaroth.conf` to change the numerical setup. By default, the program does a real-time visualization of the simulation domain. The camera and the initial conditions can be controller by `arrow keys`, `pgup`, `pgdown` and `spacebar`. +## Visualization + +See `analysis/python/` directory of existing data visualization and analysis scripts. + ## Generating documentation Run `doxygen doxyfile` in astaroth_2.0 directory. The generated files can be found in `doc/doxygen`. The main page of the documentation will be at `dox/doxygen/astaroth_doc_html/index.html`.