From 6db451d0891b2666a544c2e27dfd7ea2899ae18b Mon Sep 17 00:00:00 2001 From: Corneels Date: Fri, 11 Oct 2019 08:54:42 +1000 Subject: [PATCH 1/3] Correct spelling, grammar, syntax errors, improved layout. --- docs/index.md | 57 ++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 41 insertions(+), 16 deletions(-) diff --git a/docs/index.md b/docs/index.md index b54c70051..5200567ac 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,24 +5,49 @@ date: "July 4, 2017" output: html_document --- -The TCLB code is a parallel Lattice Boltzmann Method solver, able to run on multi-GPU -cluster architectures. +TCLB (Templated MPI+CUDA/CPU Lattice Boltzmann Code) is a parallel Lattice Boltzmann Method solver, able to be run on multi-GPU +cluster architectures. -For a quick start, please refer to the [Getting Started -guide](/1.-getting-started/installation/). +For a quick start, please refer to [1. Getting started](/1.-getting-started/installation/). -Detailed descriptions of configuration of the code and compilation, can be -found in the "Installation" part of this manual. The "Running simulations" -part details the setup and execution of fluid flow simulations with TCLB. -The "Post-processing" details the way you can analyze the results. The -"Model development" part is a reference for developers wanting to add or -modify models in TCLB. +## Contents -The "XML Reference" is an automaticaly generated reference of all -XML elements avaliable for usage in the TCLB configuration files. "Models" -is also automaticaly generated and is a reference of all models currently -avaliable, with all apropriate data for each of them. +1. Getting started -Finnaly "Tutorials" section provides several step-by-step tutorials about -model development and other things. + A quick start guide. +2. Installation + + Detailed descriptions of configuration of the code and compilation. + +3. Running simulations + + Details the setup and execution of fluid flow simulations using TCLB. + +4. Post-processing + + Details the manner in which the results can be analyzed. + +5. Model development + + A reference for developers wanting to add or modify models in TCLB. + +6. Contributing + + Details the basics of getting involved with contributing to the TCLB project. + +- General Info + + Contains general information related to TCLB, including a list of publications that employ TCLB. + +- XML Reference + + An automatically generated reference of all XML elements available for usage in the TCLB configuration files. + +- Models + + An automatically generated reference of all models currently available, including all relevant data for each. + +- Tutorials + + Provides several step-by-step tutorials on model development. \ No newline at end of file From 7a2bfe5db8e89bff9fa0b8b51ed4a05d62c50f37 Mon Sep 17 00:00:00 2001 From: Corneels Date: Fri, 11 Oct 2019 08:58:20 +1000 Subject: [PATCH 2/3] Add missing brackets to fix link. --- docs/1.-Getting-started/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/1.-Getting-started/installation.md b/docs/1.-Getting-started/installation.md index 44a7a64c9..8dfecb38a 100644 --- a/docs/1.-Getting-started/installation.md +++ b/docs/1.-Getting-started/installation.md @@ -23,7 +23,7 @@ In order to use TCLB solver, the following tools are required: * [numpy](http://www.numpy.org/) (if you want to use the integrated python interpreter) * [python](https://www.python.org/), [python](http://www.sympy.org/) * [rPython](https://cran.r-project.org/package=rPython) (if you want to develop a model using python in place or R) -* [MPI](https://en.wikipedia.org/wiki/Message_Passing_Interface) (e.g. [OpenMPI](http://www.open-mpi.org +* [MPI](https://en.wikipedia.org/wiki/Message_Passing_Interface) (e.g. [OpenMPI](http://www.open-mpi.org)) Most of them can be installed using the script provided within the code(tools/install.sh): From 8c5272b8a4dfab22a83ec7d3c8f4d5d4c67cf61e Mon Sep 17 00:00:00 2001 From: Corneels Date: Fri, 11 Oct 2019 09:02:36 +1000 Subject: [PATCH 3/3] Change bulleting style in list. --- docs/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index 5200567ac..f7f93a421 100644 --- a/docs/index.md +++ b/docs/index.md @@ -36,18 +36,18 @@ For a quick start, please refer to [1. Getting started](/1.-getting-sta Details the basics of getting involved with contributing to the TCLB project. -- General Info +* General Info Contains general information related to TCLB, including a list of publications that employ TCLB. -- XML Reference +* XML Reference An automatically generated reference of all XML elements available for usage in the TCLB configuration files. -- Models +* Models An automatically generated reference of all models currently available, including all relevant data for each. -- Tutorials +* Tutorials Provides several step-by-step tutorials on model development. \ No newline at end of file