Updating Parcels pitch in docs#1978
Conversation
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
|
|
||
|
|
||
| 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>`_. |
There was a problem hiding this comment.
set of Python classes and methods to create
A bit off-tangent for this PR, but thoughts on "modelling framework to create"?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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 :)
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