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

Examples in Documentation #141

Open
Zeitsperre opened this issue Jun 30, 2023 · 0 comments
Open

Examples in Documentation #141

Zeitsperre opened this issue Jun 30, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Zeitsperre
Copy link
Collaborator

Proposal

As of Miranda v0.5.0, Docstrings are now much more present throughout the code base, but there are no examples of how best to use Miranda for data treatments, or how best to develop modules and extend support for datasets (this has been an issue internally for some time). We would benefit from at least 3-4 example workflows showcasing how to do a few fundamental things:

  • Selecting, collecting and converting data from ECMWF
  • Archiving a folder of data and transferring it to another server
  • Converting data from ECCC from fixed-width format to NetCDF, then applying corrections for CF-compliance
  • Adding support for data treatments of a (fictional) new dataset

Some of the scripts within templates could be used to get ideas, or we could even simply convert these templates to examples.

@Zeitsperre Zeitsperre added the documentation Improvements or additions to documentation label Jun 30, 2023
@Zeitsperre Zeitsperre self-assigned this Jun 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant