From 09ddd481d53cfdbbfdf4688eecf24800d4cf3926 Mon Sep 17 00:00:00 2001 From: Caleb Schilly Date: Tue, 24 Sep 2024 11:40:57 -0400 Subject: [PATCH] #112: add changes to readme --- docs/md/mainpage.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/md/mainpage.md b/docs/md/mainpage.md index 995731322..0f63745a1 100644 --- a/docs/md/mainpage.md +++ b/docs/md/mainpage.md @@ -4,17 +4,17 @@ \section vttv_what_is What is VT TV? -`vt-tv` provides visualizations of an application's work-to-rank mappings, communications, and memory usage. +`vt-tv` provides visualizations of the work-to-rank mappings, communications, and memory usage of an application. Specifically, the task visualizer takes in JSON files that describe work as a series of phases and subphases that contain 1) tasks for each rank, 2) communications, and 3) other user-defined fields (such as memory usage). -Using this input data, the task visualizer produces Exodus meshes to describe the ranks and objects over time, which can be visualized using Paraview. Additionally, the task visualizer can produce PNGs directly using a VTK workflow to render a visualization of ranks and tasks over phases. +Using such input data, the task visualizer produces Exodus meshes to describe the ranks and objects over time, which can be visualized using Paraview. Additionally, the task visualizer can produce PNGs directly using a VTK workflow to render a visualization of ranks and tasks over phases. --- \section vttv_getting_started Getting Started -You will need the following dependencies: +You need the following dependencies: 1. A C++ compiler that supports C++17 2. [`cmake`](https://cmake.org/cmake/help/latest/) >= 3.17 @@ -26,13 +26,13 @@ Begin by cloning `vt-tv`: git clone https://github.com/DARMA-tasking/vt-tv.git ``` -_In future directions, we will assume that the `vt-tv` source is located in `${VTTV_SOURCE_DIR}`._ +_From now on, we will assume that the `vt-tv` source is located in `${VTTV_SOURCE_DIR}`._ --- \section vttv_installation_and_usage Installation and Usage -`vt-tv` can installed as either a standalone C++ app or as a Python module. +`vt-tv` can be installed as either a standalone C++ app or as a Python module. \subsection vttv_standalone Standalone @@ -58,7 +58,7 @@ Alternatively, for an interactive build process, run: ./interactive_build.sh ``` -_In future directions, we will assume that the `vt-tv` build is in `${VTTV_BUILD_DIR}`._ +_From now on, we will assume that the `vt-tv` build is in `${VTTV_BUILD_DIR}`._ \subsubsection vttv_standalone_usage 2. Usage @@ -77,7 +77,7 @@ _Note: The_ `path/to/config` _argument should be relative to_ `${VTTV_SOURCE_DIR #### YAML Input -A sample YAML configuration file can be found in `${VTTV_SOURCE_DIR}/config/conf.yaml`. To use it, run +A YAML configuration exemplar can be found in `${VTTV_SOURCE_DIR}/config/conf.yaml`. To use it, run ```bash ${VTTV_BUILD_DIR}/apps/vt_standalone -c config/conf.yaml @@ -95,7 +95,7 @@ Additionally, DARMA-tasking's Load Balancing Analysis Framework (LBAF) provides \subsubsection vttv_python_module_deps Dependencies -In addition to the basic `vt-tv` dependencies listed above, you will also need: +In addition to the basic `vt-tv` dependencies listed above, you also need: 1. A Python version between 3.8 - 3.11 2. [`nanobind`](https://nanobind.readthedocs.io/en/latest/), which can be installed with: @@ -280,13 +280,13 @@ where the `qoi_string` is the name of the desired QOI, like "load" or "id". This There are two classes that hold object data: `ObjectInfo` and `ObjectWork`. `ObjectInfo` holds information about a given object across all ranks and phases. This includes: -- the object's ID -- the object's home rank (where it originated) +- the ID +- the home rank (where the object originated) - whether the object is migratable or sentinel (stays on the same rank) -`ObjectWork` holds information that may change as an object changes rank or phase, such as: -- the object's attributes -- the object's communications +`ObjectWork` holds information about an object that may vary as it changes rank or phase, such as: +- the attributes +- the communications _Tip: As discussed above, users should utilize the getters present in `Info` rather than directly calling these classes._