From a9e3c18a1501d99ee03e31bde6f8a78f025ca87b Mon Sep 17 00:00:00 2001 From: Hannah Klion Date: Fri, 27 Dec 2024 13:22:14 -0800 Subject: [PATCH] move min_file_digits docs to checkpoint and plotfile pages --- Docs/sphinx_doc/Checkpoint.rst | 30 ++++++++++-------- Docs/sphinx_doc/Inputs.rst | 12 ------- Docs/sphinx_doc/Plotfiles.rst | 58 ++++++++++++++++++---------------- 3 files changed, 48 insertions(+), 52 deletions(-) diff --git a/Docs/sphinx_doc/Checkpoint.rst b/Docs/sphinx_doc/Checkpoint.rst index 554cff69..a5e10f96 100644 --- a/Docs/sphinx_doc/Checkpoint.rst +++ b/Docs/sphinx_doc/Checkpoint.rst @@ -22,19 +22,23 @@ Writing the Checkpoint "Files" List of Parameters ------------------ -+----------------------------------+----------------+----------------+----------------+ -| Parameter | Definition | Acceptable | Default | -| | | Values | | -+==================================+================+================+================+ -| **remora.check_file** | prefix for | String | “*chk*” | -| | restart files | | | -+----------------------------------+----------------+----------------+----------------+ -| **remora.check_int** | how often (by | Integer | -1 | -| | level-0 time | :math:`> 0` | | -| | steps) to | | | -| | write restart | | | -| | files | | | -+----------------------------------+----------------+----------------+----------------+ ++----------------------------------+-----------------------------------+----------------+----------------+ +| Parameter | Definition | Acceptable | Default | +| | | Values | | ++==================================+===================================+================+================+ +| **remora.check_file** | prefix for | String | “*chk*” | +| | restart files | | | ++----------------------------------+-----------------------------------+----------------+----------------+ +| **remora.check_int** | how often (by | Integer | -1 | +| | level-0 time | :math:`> 0` | | +| | steps) to | | | +| | write restart | | | +| | files | | | ++----------------------------------+-----------------------------------+----------------+----------------+ +| **remora.file_min_digits** | Minimum number of digits | Integer >= 0 | 5 | +| | in iteration number appended to | | | +| | plotfile and checkpoint files | | | ++----------------------------------+-----------------------------------+----------------+----------------+ Restarting ========== diff --git a/Docs/sphinx_doc/Inputs.rst b/Docs/sphinx_doc/Inputs.rst index ac5549f0..1d636676 100644 --- a/Docs/sphinx_doc/Inputs.rst +++ b/Docs/sphinx_doc/Inputs.rst @@ -401,18 +401,6 @@ Examples of Usage **remora.init_shrink** :math:`\neq 1` then the first time step will in fact be **remora.init_shrink** \* **remora.fixed_dt**. -File Output -=========== - -+-------------------------------+-----------------------------------+----------------+----------------------------+ -| Parameter | Definition | Acceptable | Default | -| | | Values | | -+===============================+===================================+================+============================+ -| **remora.file_min_digits** | Minimum number of digits | Integer >= 0 | 5 | -| | in iteration number appended to | | | -| | plotfile and checkpoint files | | | -+-------------------------------+-----------------------------------+----------------+----------------------------+ - Restart Capability ================== diff --git a/Docs/sphinx_doc/Plotfiles.rst b/Docs/sphinx_doc/Plotfiles.rst index 1c06a649..f7719f5f 100644 --- a/Docs/sphinx_doc/Plotfiles.rst +++ b/Docs/sphinx_doc/Plotfiles.rst @@ -21,33 +21,37 @@ The following options in the inputs file control the generation of plotfiles. List of Parameters ------------------ -+--------------------------------+------------------+-----------------------+------------+ -| Parameter | Definition | Acceptable | Default | -| | | Values | | -+================================+==================+=======================+============+ -| **remora.plotfile_type** | AMReX or NETCDF | "amrex" or | "amrex" | -| | | "netcdf / "NetCDF" | | -+--------------------------------+------------------+-----------------------+------------+ -| **remora.write_history_file** | do we write | false or true | true | -| | netcdf files at | | | -| | each timestep | | | -| | or one file for | | | -| | all timesteps? | | | -+--------------------------------+------------------+-----------------------+------------+ -| **remora.plot_file** | prefix for | String | “plt” | -| | plotfiles | | | -+--------------------------------+------------------+-----------------------+------------+ -| **remora.plot_int** | how often (by | Integer | -1 | -| | level-0 time | :math:`> 0` | | -| | steps) to write | | | -| | plot files | | | -+--------------------------------+------------------+-----------------------+------------+ -| **remora.plot_vars** | name of | list of names | None | -| | variables to | (see table below) | | -| | include in | | | -| | plotfiles. Not | | | -| | used for netCDF | | | -+--------------------------------+------------------+-----------------------+------------+ ++--------------------------------+-----------------------------------+-----------------------+------------+ +| Parameter | Definition | Acceptable | Default | +| | | Values | | ++================================+===================================+=======================+============+ +| **remora.plotfile_type** | AMReX or NETCDF plotfiles | "amrex" or | "amrex" | +| | | "netcdf / "NetCDF" | | ++--------------------------------+-----------------------------------+-----------------------+------------+ +| **remora.file_min_digits** | Minimum number of digits | Integer >= 0 | 5 | +| | in iteration number appended to | | | +| | plotfile and checkpoint files | | | ++--------------------------------+-----------------------------------+-----------------------+------------+ +| **remora.write_history_file** | do we write | false or true | true | +| | netcdf files at | | | +| | each timestep | | | +| | or one file for | | | +| | all timesteps? | | | ++--------------------------------+-----------------------------------+-----------------------+------------+ +| **remora.plot_file** | prefix for | String | “plt” | +| | plotfiles | | | ++--------------------------------+-----------------------------------+-----------------------+------------+ +| **remora.plot_int** | how often (by | Integer | -1 | +| | level-0 time | :math:`> 0` | | +| | steps) to write | | | +| | plot files | | | ++--------------------------------+-----------------------------------+-----------------------+------------+ +| **remora.plot_vars** | name of | list of names | None | +| | variables to | (see table below) | | +| | include in | | | +| | plotfiles. Not | | | +| | used for netCDF | | | ++--------------------------------+-----------------------------------+-----------------------+------------+ .. _notes-5: