Skip to content

Commit

Permalink
add summaryPlots to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
drsteve committed Mar 24, 2023
1 parent 11bc91b commit 8234713
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/Tex/RAM_SCB_viz.tex
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ \section{SpacePy}

For documentation and examples, please see \href{https://spacepy.github.io/autosummary/spacepy.pybats.ram.html}{https://spacepy.github.io/autosummary/spacepy.pybats.ram.html}

\subsection{Summary plotting tool}
Building on the capabilities provided by SpacePy, RAM-SCB also provides the `summaryPlots.py' command line tool in the {\tt Scripts} directory. This can be invoked on the command line (e.g., in a terminal window) by calling {\tt python summaryPlots.py --help}. The utility will generate a set of standard summary plots for a simulation, with some additional control over the plotting via supplied command line arguments. SpacePy must be installed to use this tool.

\section{VTK: The Visualization Toolkit}
Basic support for VTK-based visualization is provided in the {\tt Scripts/viz} subdirectory.

Expand Down

0 comments on commit 8234713

Please sign in to comment.