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

added Jinghan Fu into zenodo #777

Merged
merged 1 commit into from
Nov 26, 2024
Merged

Conversation

JinghanFu
Copy link
Contributor

Please work through the following checklists. Delete anything that isn't relevant.

Development for new xarray-based metrics

  • Works with n-dimensional data and includes reduce_dims, preserve_dims, and weights args.
  • Typehints added
  • Add error handling
  • Imported into the API
  • Works with both xr.DataArrays and xr.Datasets if possible

Docstrings

  • Docstrings complete and follow Napoleon (google) style
  • Maths equation added
  • Reference to paper/webpage is in docstring. The preferred referencing style for journal articles is APA (7th edition)
  • Code example added

Testing of new xarray-based metrics

  • 100% unit test coverage
  • Test that metric is compatible with dask.
  • Test that metrics work with inputs that contain NaNs
  • Test that broadcasting with xarray works
  • Test both reduce and preserve dims arguments work
  • Test that errors are raised as expected
  • Test that it works with both xr.DataArrays and xr.Datasets

Tutorial notebook

  • Short introduction to why you would use that metric and what it tells you
  • A link to a reference
  • A "things to try next" section at the end
  • Add notebook to Tutorial_Gallery.ipynb
  • Optional - a detailed discussion of how the metric works at the end of the notebook

Documentation

@Steph-Chong
Copy link
Collaborator

Steph-Chong commented Nov 26, 2024

Thanks for doing that @JinghanFu.

After your PR #772 is merged, when I next update the release notes I will include you as "Fu Jinghan (@JinghanFu)". Is that how you want to be included in the release notes?

If it should be "Jinghan Fu (@JinghanFu)", or formatted another way, please let me know.

@JinghanFu
Copy link
Contributor Author

Thank you, Steph! Jinghan Fu (@JinghanFu) will be good! Thank you again!

@Steph-Chong
Copy link
Collaborator

Thank you, Steph! Jinghan Fu (@JinghanFu) will be good! Thank you again!

Excellent - Jinghan Fu (@JinghanFu) is how it will be included.

@JinghanFu
Copy link
Contributor Author

Thank you so much!

@tennlee tennlee merged commit 1fc1d78 into nci:develop Nov 26, 2024
tennlee pushed a commit that referenced this pull request Dec 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants