Add parcels._datasets subpackage and developer documentation
#1972
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
|
@erikvansebille could you checkout the dev documentation and let me know what you think? |
VeckoTheGecko
commented
Apr 9, 2025
Contributor
Author
|
ci failure is unrelated - not sure why it flaked. As good as green |
VeckoTheGecko
commented
Apr 9, 2025
parcels/_datasets/__init__.py
Outdated
|
|
||
| This subpackage is broken down into structured and unstructured parts. Each of these have common submodules: | ||
|
|
||
| * ``providers`` -> hardcoded datasets with the intention of mimicking datasets from a certain provider |
Contributor
Author
There was a problem hiding this comment.
Perhaps another word than providers? I'm meaning more NEMO/Mitgcm/CROCO/ROMS/mom5 etc ...
Member
There was a problem hiding this comment.
circulationmodels? See also the comment above about aligning with the text on oceanparcels.org
parcels/_datasets/__init__.py
Outdated
|
|
||
| This subpackage is broken down into structured and unstructured parts. Each of these have common submodules: | ||
|
|
||
| * ``providers`` -> hardcoded datasets with the intention of mimicking datasets from a certain provider |
Member
There was a problem hiding this comment.
circulationmodels? See also the comment above about aligning with the text on oceanparcels.org
Co-authored-by: Erik van Sebille <e.vansebille@uu.nl>
for more information, see https://pre-commit.ci
Co-authored-by: Erik van Sebille <e.vansebille@uu.nl>
erikvansebille
approved these changes
Apr 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In line with #1965, I have added a
parcels._datasetssubpackage. See the developer documentation inparcels/_datasets/__init__.pyfor more info.I think that this really helps us with testing, user documentation (for the advanced users, who want to see exactly all the datasets that we support), and maintenance (since in our tests we can just rely on these example datasets, rather than having to create them from scratch as we currently do quite a bit).
This will will need to be surfaced in some way in the documentation down the line - I'll make an issue for that now.
v4-devfor v4 changes)