Skip to content
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.

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

Documentation for example datasets #101

Open
VeckoTheGecko opened this issue Aug 7, 2024 · 1 comment
Open

Documentation for example datasets #101

VeckoTheGecko opened this issue Aug 7, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@VeckoTheGecko
Copy link
Contributor

VeckoTheGecko commented Aug 7, 2024

Is there any documentation about the datasets in examples-data (which are in turn used throughout the parcels examples)? Perhaps it would be worth adding a file examples-data/README.md to add quick descriptions to these. This can be propagated through to users in parcels if we want as well just by linking to the README here on GitHub.

Motivation

parcels_tutorial.ipynb mentions

since we know that the files are in what’s called Parcels FieldSet format, we can call these files using the function FieldSet.from_parcels()

I feel like the following would be better

The "MovingEddies_data" dataset contains data that is in Parcels FieldSet format. We can ingest this data into parcels using FieldSet.from_parcels(). For more information on available datasets see link

@VeckoTheGecko VeckoTheGecko added the enhancement New feature or request label Aug 7, 2024
@erikvansebille
Copy link
Member

Yes, I fully agree! Probably best if I write this README, since I know where the datasets came from. I'll assign to myself

@erikvansebille erikvansebille self-assigned this Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants