SEEPS

[nicholasloveday]

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

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

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

• Add the score to the API documentation
• Add the score to the included list of metrics and tools

[nicholasloveday]

Currently work in progress, but I'm just putting it up here in case anyone wants to take an early look. I still need to write the tutorial.

Now ready for review.