Parcels v4 paper - #2838
Conversation
|
@fluidnumericsJoe This is where we're writing the paper for JOSS :) . I've put a first draft together, it would be great to have your review on it. No particular rush - @erikvansebille is on leave until the 31st now - but thought I would give you a heads up. Happy to discuss when we next meet. |
|
Looking through the section requirements for JOSS, the paper should also have a "State of the field" section. Maybe would be best if you write that @erikvansebille ? Happy to hear your thoughts too @fluidnumericsJoe of course. |
And references
erikvansebille
left a comment
erikvansebille
left a comment
There was a problem hiding this comment.
Some detailed textual suggestions and questions below
| index: 1 | ||
| - name: Fluid Numerics, Hickory, NC, USA | ||
| index: 2 | ||
| date: 17 August 2026 |
There was a problem hiding this comment.
Don't forget to update this just before submission
Co-authored-by: Erik van Sebille <e.vansebille@uu.nl>
|
The md file looks good now! Do you know how/where I can find the rendered version of the paper? So I can also check what it looks like in pdf? |
| # Software design | ||
|
|
||
| When working with output from a single circulation model, version 4 of Parcels assumes data (i.e., the field data and mesh data) is all contained in a single Xarray Dataset object that has appropriate metadata. | ||
| This required metadata includes certain CF-convention metadata, providing information about important variables/coordinates and their units, as well SGRID or UGRID metadata, providing grid geometry information for structured grid data and unstructured grid data respectively. |
There was a problem hiding this comment.
Are there references for SGRID and UGRID? Perhaps this comment provides a way to do that? cf-convention/cf-convention.github.io#67 (comment)
There was a problem hiding this comment.
For CF and UGRID, I think that would be good, AFAIK SGRID doesn't have a publication(?) just a website
There was a problem hiding this comment.
I think you can cite websites in JOSS papers?
|
|
||
| When working with output from a single circulation model, version 4 of Parcels assumes data (i.e., the field data and mesh data) is all contained in a single Xarray Dataset object that has appropriate metadata. | ||
| This required metadata includes certain CF-convention metadata, providing information about important variables/coordinates and their units, as well SGRID or UGRID metadata, providing grid geometry information for structured grid data and unstructured grid data respectively. | ||
| This metadata rich object can either opened directly from disk/a data store, or is constructed by the user from the component input/output files from their particular circulation model. |
There was a problem hiding this comment.
I don't understand what you mean with "component input/output files". Can you clarify?
There was a problem hiding this comment.
You have both the field outputs, but sometimes the mesh is not actually the output of the model (but is the input). Hence we care about both the input and output of the circulation model.
Do you have a suggestion on better wording?
There was a problem hiding this comment.
Perhaps simply remove this detail then: "or is constructed by the user from the original files of their particular circulation model."
And maybe "original" is not even needed?
Co-authored-by: Erik van Sebille <e.vansebille@uu.nl>
|
@erikvansebille I have added a PDF build workflow to the repo monitoring for changes in Here's the PDF from the latest commit |
Co-authored-by: Erik van Sebille <e.vansebille@uu.nl>
Co-authored-by: Erik van Sebille <e.vansebille@uu.nl>
2 participants
No description provided.