Skip to content

WIP Documentation review #221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
mo-marqh wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

WIP Documentation review #221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
180b49f
consistency single output
mo-marqh Feb 26, 2026
1515751
Update index.rst
mo-marqh Feb 26, 2026
67e0c73
post processing developer constraints
mo-marqh Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions documentation/Sphinx/developer_guide/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ Vernier.
dev_process
testing
review_process
post_processing
34 changes: 34 additions & 0 deletions documentation/Sphinx/developer_guide/post_processing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
.. -----------------------------------------------------------------------------
(c) Crown copyright 2026 Met Office. All rights reserved.
The file LICENCE, distributed with this code, contains details of the terms
under which the code may be used.
-----------------------------------------------------------------------------

Post Processing Design
======================

The post processing is delivered in Python, independent of the code calipering functionality.

The post processing is implemented as a library, which can beb used by Python programmes, and as a set of callable scripts.

Callable Script Design Constraints
----------------------------------

Callable scripts enable the outputs from Verniered runs to be parsed without writing code.

For maintainability and ease of use reasons, these are limited by design constraints:

* Inputs only: locations (file path)
* Outputs only: text to stdout only

Python Module Design Constraints
--------------------------------

The importable Python modules enable programmatic interaction with data parsed from Vernier output files.

For maintainability reasons, these are limited by design constraints:

* Enable parsing of Vernier structured data files.
* Enable organsiation and aggregation of Vernier data.
* No plotting, ever (this is user responsibility).
* Functionality shall be tested.
6 changes: 3 additions & 3 deletions documentation/Sphinx/user_guide/output/interpreting-output.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Interpreting Output
-------------------

By default Vernier will write information out into one file per MPI rank.
Single file output is not currently supported but is achievable via
post-processing techniques.
Single file output is supported via the environment variable:
``VERNIER_OUTPUT_MODE=single``

Each file contains a table of the all the declared regions and their
associated walltimes.
Expand Down Expand Up @@ -76,4 +76,4 @@ To reiterate, the two output format options are **threads** and **drhook**.
* The self and total time per call (in ms) is also given.

In both examples the ``@0`` appended onto the end of all region names indicates
the OpenMP thread number.
the OpenMP thread number.