From 6ed00d499b40fffc069b9056becf9be91f90334b Mon Sep 17 00:00:00 2001 From: Casey Icenhour Date: Sun, 8 Jan 2023 22:20:26 -0700 Subject: [PATCH] Add peacock to the zapdos getting started instructions (#41) --- doc/config.yml | 4 ++++ doc/content/getting_started/using_zapdos.md | 17 ++++++++++++----- doc/zapdos_shortcuts.yml | 2 ++ 3 files changed, 18 insertions(+), 5 deletions(-) diff --git a/doc/config.yml b/doc/config.yml index cbd99ca5f3f..0db3bee572e 100644 --- a/doc/config.yml +++ b/doc/config.yml @@ -4,6 +4,10 @@ Content: - ${ROOT_DIR}/crane/doc/content - ${ROOT_DIR}/squirrel/doc/content - ${ROOT_DIR}/doc/doxygen/ + - moose_files: + root_dir: ${MOOSE_DIR}/modules/doc/content + content: + - application_usage/peacock.md Renderer: type: MooseDocs.base.MaterializeRenderer extra-css: diff --git a/doc/content/getting_started/using_zapdos.md b/doc/content/getting_started/using_zapdos.md index 41801bd9042..056425f9055 100644 --- a/doc/content/getting_started/using_zapdos.md +++ b/doc/content/getting_started/using_zapdos.md @@ -25,10 +25,9 @@ console output can be sent to a text file: The `--color off` option is to de-clutter the log file from extraneous mark-up resulting from the displayed console text colors. -For parallelism, users can use the Message Passing Interface protocol (MPI). The -[MPICH](https://www.mpich.org/) implementation of MPI is provided with the MOOSE -environment packages. A parallel simulation using 4 processors can be run with the -following basic syntax: +For parallelism, users can use the [!ac](MPI) protocol. The [MPICH] implementation of [!ac](MPI) is +provided with the [!ac](MOOSE) environment packages. A parallel simulation using 4 processors can be +run with the following basic syntax: ```bash mpiexec -n 4 ~/projects/zapdos/zapdos-opt -i example_input.i @@ -37,7 +36,15 @@ mpiexec -n 4 ~/projects/zapdos/zapdos-opt -i example_input.i Many test input files also create an output file with the name format `example_input_out.e` that contains all the simulation results that have been selected for output. These results are best viewed using a visualization tool -like [Paraview](http://www.paraview.org/download/). +like [ParaView]. + +## Using Zapdos with Peacock, the MOOSE Graphical User Interface (GUI) + +!style halign=left +While using Zapdos on the command line is the standard and recommended method for using the code and +visualizing the results, a GUI is available for use through the [!ac](MOOSE) framework. Peacock is a +general front end for [!ac](MOOSE) input file syntax, simulation, and visualiztion. General directions +compatible with all [!ac](MOOSE)-based applications can be found [at this link](application_usage/peacock.md). ## Zapdos Tutorial and Tests diff --git a/doc/zapdos_shortcuts.yml b/doc/zapdos_shortcuts.yml index d1983154e95..11d0f5a82e7 100644 --- a/doc/zapdos_shortcuts.yml +++ b/doc/zapdos_shortcuts.yml @@ -1 +1,3 @@ Reactions: /syntax/Reactions/index.md +MPICH: https://www.mpich.org/ +ParaView: https://www.paraview.org/