Skip to content

Parcels v4 paper - #2838

Open
VeckoTheGecko wants to merge 32 commits into
mainfrom
paper-v4
Open

Parcels v4 paper#2838
VeckoTheGecko wants to merge 32 commits into
mainfrom
paper-v4

Conversation

@VeckoTheGecko

Copy link
Copy Markdown
Contributor

No description provided.

@VeckoTheGecko

VeckoTheGecko commented Aug 19, 2026

Copy link
Copy Markdown
Contributor Author

@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.

@VeckoTheGecko

Copy link
Copy Markdown
Contributor Author

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.

Comment thread docs/paper-v4/data-ingestion.png
Comment thread docs/paper-v4/paper.md

@erikvansebille erikvansebille left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some detailed textual suggestions and questions below

Comment thread docs/paper-v4/data-ingestion.png
Comment thread docs/paper-v4/paper.bib Outdated
Comment thread docs/paper-v4/paper.md
index: 1
- name: Fluid Numerics, Hickory, NC, USA
index: 2
date: 17 August 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't forget to update this just before submission

Comment thread docs/paper-v4/paper.md Outdated
Comment thread docs/paper-v4/paper.md Outdated
Comment thread docs/paper-v4/paper.md Outdated
Comment thread docs/paper-v4/paper.md Outdated
Comment thread docs/paper-v4/paper.md Outdated
Comment thread docs/paper-v4/paper.md Outdated
Comment thread docs/paper-v4/paper.md Outdated
@erikvansebille

Copy link
Copy Markdown
Member

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?

Comment thread docs/paper-v4/paper.md
# 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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there references for SGRID and UGRID? Perhaps this comment provides a way to do that? cf-convention/cf-convention.github.io#67 (comment)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For CF and UGRID, I think that would be good, AFAIK SGRID doesn't have a publication(?) just a website

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can cite websites in JOSS papers?

Comment thread docs/paper-v4/paper.md Outdated
Comment thread docs/paper-v4/paper.md Outdated
Comment thread docs/paper-v4/paper.md Outdated
Comment thread docs/paper-v4/paper.md Outdated
Comment thread docs/paper-v4/paper.md Outdated
@VeckoTheGecko

Copy link
Copy Markdown
Contributor Author

@erikvansebille I have added a PDF build workflow to the repo monitoring for changes in docs/paper-v4/* and building the PDF attaching as an artifact to the workflow.

Here's the PDF from the latest commit

paper.pdf

Comment thread docs/paper-v4/paper.md Outdated
Comment thread docs/paper-v4/paper.md Outdated
VeckoTheGecko and others added 3 commits September 4, 2026 20:37
Co-authored-by: Erik van Sebille <e.vansebille@uu.nl>
Co-authored-by: Erik van Sebille <e.vansebille@uu.nl>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

2 participants