JOSS paper

.github/workflows/draft-pdf.yml

@@ -0,0 +1,28 @@
+name: Draft PDF
+on:
+  push:
+    paths:
+      - paper/**
+      - .github/workflows/draft-pdf.yml
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+    name: Paper Draft
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Build draft PDF
+        uses: openjournals/openjournals-draft-action@master
+        with:
+          journal: joss
+          # This should be the path to the paper within your repo.
+          paper-path: paper/paper.md
+      - name: Upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: paper
+          # This is the output path where Pandoc will write the compiled
+          # PDF. Note, this should be the same directory as the input
+          # paper.m
+          path: paper/paper.pdf

paper/paper.bib

@@ -0,0 +1,36 @@
+@manual{nemo,
+  title     = {Nucleus for European Modelling of the Ocean (NEMO)},
+  author    = {{NEMO Consortium}},
+  year      = {2023},
+  url       = {https://www.nemo-ocean.eu/},
+}
+
+@misc{cdftoolsJMMP,
+  title        = {CDFTOOLS: JMMP-Group Development Branch},
+  author       = {{JMMP-Group}},
+  year         = {2024},
+  howpublished = {\url{https://github.com/JMMP-Group/CDFTOOLS}},
+}
+
+@article{hoyer2017xarray,
+  title     = {xarray: {N-D} labeled arrays and datasets in {Python}},
+  author    = {Hoyer, S. and J. Hamman},
+  journal   = {Journal of Open Research Software},
+  volume    = {5},
+  number    = {1},
+  year      = {2017},
+  publisher = {Ubiquity Press},
+  doi       = {10.5334/jors.148},
+  url       = {http://doi.org/10.5334/jors.148}
+}
+
+@inproceedings{SLURM,
+author = {Jette, Morris and Yoo, Andy and Grondona, Mark},
+year = {2003},
+month = {07},
+pages = {},
+title = {SLURM: Simple linux utility for resource management},
+isbn = {978-3-540-20405-3},
+journal = {LECTURE NOTES IN COMPUTER SCIENCE},
+doi = {10.1007/10968987_3}
+}

paper/paper.md

@@ -0,0 +1,72 @@
+---
+title: 'MARINE_VAL: A command line software tool to assess ocean general circulation model outputs'
+tags:
+  - Bash
+  - Python
+  - oceanography
+authors:
+  - name: Hatim Chahout
+    orcid: 0009-0001-1395-8942
+    affiliation: 1
+  - name: Diego Bruciaferri
+    orcid: 0000-0001-5114-693X
+    affiliation: 1
+  - name: Dave Storkey
+    orcid: 0000-0001-8000-5335
+    affiliation: 1
+affiliations:
+ - name: Met Office Hadley Centre
+   index: 1
+date: \today
+bibliography: paper.bib
+---
+
+# Statement of Need
+Numerical ocean general circulation models (OGCMs) are routinely run at increasingly high spatial and temporal resolutions, resulting in simulations that are both computationally demanding and generate vast amounts of data. As a consequence, extracting meaningful oceanographic metrics from these outputs has become more complex and time-consuming, presenting significant challenges for researchers and impeding the pace of model development. MARINE_VAL was developed to address these issues by providing a streamlined and standardised approach for model evaluation.
+
+# Summary
+MARINE_VAL is an open-source command-line software package developed for researchers to streamline the evaluation of OGCM outputs. By standardising the calculation and visualisation of scalar evaluation metrics, it enables direct comparison with observational datasets, while also fostering reproducibility and comparability across studies. Although MARINE_VAL is primarily tailored for NEMO [@nemo] outputs across a range of resolutions, its flexible design allows for straightforward adaptation to other structured grid models. The package integrates CDFTOOLS [@cdftoolsJMMP] and xarray [@hoyer2017xarray] to deliver efficient and scalable data processing, ultimately facilitating quicker model development and analysis.
+
+# Features
+## Diagnostic Computation
+MARINE_VAL computes a comprehensive set of diagnostics, organised into three principal metric groups: Southern Ocean assessment (VALSO), North Atlantic assessment (VALNA), and straits transports/exchanges (VALTRANS). Users have the flexibility to select any combination of metrics to suit their specific research needs by editing the user configuration file `param.bash`. The package is designed to harness SLURM [@SLURM] and HPC parallel processing for efficient job execution and data retrieval from archive systems, while also offering the flexibility to bypass data retrieval through the user configuration file to use locally stored model data. If a user wants to use an alternative data archive system to MASS, then `get_data.bash` will need to be adapted accordingly.
+
+**VALSO** (Southern Ocean assessment):
+Provides metrics for evaluating the strength and variability of major Southern Ocean currents and water masses, such as the Antarctic Circumpolar Current, regional gyres, shelf water properties, and deep water formation.
+
+**VALNA** (North Atlantic assessment):
+Focuses on diagnostics relevant to North Atlantic circulation, such as subpolar gyre strength, heat and salt content, overturning circulation, mixed layer depth, and key regional anomalies and profiles.
+
+**VALTRANS** (Straits transports and exchanges):
+Assesses the transport and exchange of water masses through major straits and passages, including deep overflows, marginal sea exchanges, and inter-basin throughflows.
+
+ACTION: Add to, or remove the table?
+
+| Diagnostic | Description |
+|-:|:---|
+| Census of Antarctic Bottom Water | $\displaystyle{\sigma_4 > 45.88}$, where $\displaystyle{\sigma_4 = \rho(S, \Theta, 4000 \text{ dbar}) - 1000 \text{ kg/m}^3}$ |
+
+## Visualisation
+MARINE_VAL features automated plotting scripts that produce standardised figures for each diagnostic package. In addition, specific processes can generate geospatial plots that visualise aggregated vertical data, such as sums, means, or anomalies, across the analysis regions. Users have control over the appearance of these figures, with options to customise labels, colors, and line styles through the style configuration file `style.db`. 
+
+### A geospatial example: The Mediterannean Overflow
+One practical application of MARINE_VAL is its ability to seamlessly produce scatter plots of temperature, salinity, and model bathymetry in the analysis regions, as seen in Figure \autoref{fig:MEDOVF}. These outputs can help researchers assess the realism of their simulations and identify areas for model improvement.
+
+![\label{fig:MEDOVF}](medovf.png)
+
+### A temporal example: VALSO
+Another practical application of MARINE_VAL is regionally grouped model evaluation. For instance, researchers can use MARINE_VAL to calculate key Southern Ocean diagnostics relating to its circulation, temperature, salinity and density in key regions, and visualise them together on one set of plots, all using one command.  
+
+To perform such an analysis, users will have already configured and calculated the required diagnostics. The plotting script collates the scalar metrics over the calculated time period for each diagnostic, and produces a set of time-series plots, as seen in Figure \autoref{fig:VALSO_TS}. The results can be directly compared to published observational values, seen in the accompanying distribution to the right of each plot.
+
+![\label{fig:VALSO_TS}](valso.png)
+
+# Relation to ongoing research projects
+ACTION: Update for a set of past or ongoing research projects using the software?
+
+MARINE_VAL is part of ongoing efforts to improve the accessibility and evaluation of large ocean model datasets. The package builds on community-developed tools and supports collaborative research in ocean model development a evaluation.
+
+# Acknowledgments
+This is the Met Office development of the original VALSO code by Pierre Mathiot. The package acknowledges contributions from the ocean modeling community and support from collaborating institutions. Further acknowledgements and references are provided in the README.
+
+# References