Skip to content

Commit

Permalink
add note about plotfile prefixes containing directory
Browse files Browse the repository at this point in the history
  • Loading branch information
hklion committed Dec 15, 2023
1 parent 787293c commit 7557e72
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions Docs/sphinx_doc/Plotfiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,19 +71,22 @@ Notes

- The NeTCDF option is only available if ROMSX has been built with USE_NETCDF enabled.

- File prefixes can include directories.

.. _examples-of-usage-8:

Examples of Usage
-----------------

- **romsx.plotfile_type** = *amrex*

- **romsx.plot_file_1** = *plt_run*
- **romsx.plot_file_1** = *out/plt_run*

- **romsx.plot_int_1** = 10

means that native plot files (actually directories) starting with the prefix
“*plt_run*” will be generated every 10 level-0 time steps. If using
“*plt_run*” will be generated every 10 level-0 time steps in the directory
`out`. If using
amrex format, that directory names will be *plt_run00000*, *plt_run00010*,
*plt_run00020*, etc. If using NetCDF format, the names will have ".nc" appended.

Expand Down

0 comments on commit 7557e72

Please sign in to comment.