Skip to content

Updating Parcels pitch in docs #1978

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

Merged
erikvansebille merged 2 commits into from
Jul 24, 2025
Merged

Updating Parcels pitch in docs #1978

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0448095
Updating Parcels pitch in readme
erikvansebille Apr 17, 2025
9e0afa9
Merge branch 'v4-dev' into update_parcels_pitch_readme
erikvansebille Jul 24, 2025
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
2 changes: 1 addition & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Parcels documentation
=====================


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 •
edited
Loading

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

@erikvansebille erikvansebille Apr 22, 2025

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 •
edited
Loading

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 :)


.. figure:: _static/homepage.gif
:class: dark-light
Expand Down
Loading