Skip to content

Updating Parcels pitch in docs#1978

Merged
erikvansebille merged 2 commits intov4-devfrom
update_parcels_pitch_readme
Jul 24, 2025
Merged

Updating Parcels pitch in docs#1978
erikvansebille merged 2 commits intov4-devfrom
update_parcels_pitch_readme

Conversation

@erikvansebille
Copy link
Copy Markdown
Member

@erikvansebille erikvansebille commented Apr 17, 2025

As we move towards v4, I feel it's time to say goodbye to the tongue-in-cheek bacronym for Parcels. We don't use it anymore on the revamped oceanparcels.org website, and when we remove it here in the readme it will be gone from the codebase too.

I also aligned the pitch with that on the oceanparcels website

As we move towards v4, I feel it's time to say goodbye to the funny bacronym for Parcels. We don't use it anymore on the revamped oceanparcels.org website, and when we remove it here in the readme it will be gone from the codebase too.

I also aligned the pitch with that on the oceanparcels website
Comment thread docs/index.rst


Welcome to the documentation of Parcels. **Parcels** (Probably A Really Computationally Efficient Lagrangian Simulator) is a set of Python classes and methods to create customisable particle tracking simulations using output from Ocean Circulation models. Parcels can be used to track passive and active particulates such as water, plankton, `plastic <http://www.topios.org/>`_ and `fish <https://github.com/Jacketless/IKAMOANA>`_.
Welcome to the documentation of Parcels. **Parcels** provides a set of Python classes and methods to create customisable particle tracking simulations using gridded output from (ocean) circulation models. Parcels can be used to track passive and active particulates such as water, plankton, `plastic <http://www.topios.org/>`_ and `fish <https://github.com/Jacketless/IKAMOANA>`_.
Copy link
Copy Markdown
Contributor

@VeckoTheGecko VeckoTheGecko Apr 17, 2025

Choose a reason for hiding this comment

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

set of Python classes and methods to create

A bit off-tangent for this PR, but thoughts on "modelling framework to create"?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Well, I like that we explicitly state it's a set of Python classes and methods; I always emphasise that in my presentations to oceanographers because they typically think of a modelling framework as a black-box code that you can adapt using nameless etc; while Parcels is more a toolset. So I'd prefer to keep as is

Copy link
Copy Markdown
Contributor

@VeckoTheGecko VeckoTheGecko Apr 22, 2025

Choose a reason for hiding this comment

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

because they typically think of a modelling framework as a black-box code

I see. From a software engineering/data science POV hearing "framework" I think of something like Pandas (dataframes) and Sklearn (fit-predict) APIs that offer a lot of flexibility but provide a structured way of thinking about the problem.

So I'd prefer to keep as is

Sounds good. Our main target demographic is oceanographers anyway :)

@erikvansebille erikvansebille changed the title Updating Parcels pitch in readme Updating Parcels pitch in docs Apr 22, 2025
@erikvansebille erikvansebille merged commit 04c75f4 into v4-dev Jul 24, 2025
9 checks passed
@erikvansebille erikvansebille deleted the update_parcels_pitch_readme branch July 24, 2025 07:04
@github-project-automation github-project-automation bot moved this from Backlog to Done in Parcels development Jul 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants