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

Update Key Benefits page #666

Merged
merged 3 commits into from
Sep 11, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/key_features.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,19 @@
- Works with labelled, n-dimensional data (e.g., geospatial, vertical and temporal dimensions) for both point-based and gridded data. `scores` can effectively handle the dimensionality, data size and data structures commonly used for:
- gridded Earth system data (e.g., numerical weather prediction models)
Steph-Chong marked this conversation as resolved.
Show resolved Hide resolved
- tabular, point, latitude/longitude or site-based data (e.g., forecasts for specific locations).
- Handles missing data, masking of data and weighting of results.
- Supports [xarray](https://xarray.dev/) datatypes, and works with [NetCDF4](https://doi.org/10.5065/D6H70CW6), [HDF5](https://github.com/HDFGroup/hdf5), [Zarr](https://zarr.dev) and [GRIB](https://codes.wmo.int/grib2) data sources among others.
- Handles missing data, masking of data and [weighting of results](project:./tutorials/Weighting_Results.md) (e.g. by area, by latitude, by population).
- Supports [xarray](https://xarray.dev/) datatypes, and works with [NetCDF4](https://doi.org/10.5065/D6H70CW6), [HDF5](https://github.com/HDFGroup/hdf5), [Zarr](https://zarr.dev) and [GRIB](https://codes.wmo.int/grib2) data formats among others.

## Usability

- A companion Jupyter Notebook [tutorial](project:./tutorials/Tutorial_Gallery.md) for each metric and statistical test that demonstrates its use in practice.
- [Over 60 metrics, statistical techniques and data processing tools](included.md), including:
- commonly-used metrics (e.g., mean absolute error (MAE), root mean squared error (RMSE))
- novel scores not commonly found elsewhere (e.g., FIxed Risk Multicategorical (FIRM) score ([Taggart et al., 2022](https://doi.org/10.1002/qj.4266)), Flip-Flop Index ([Griffiths et al., 2019](https://doi.org/10.1002/met.1732), [2021](https://doi.org/10.1071/ES21010)))
- complex scores (e.g., threshold-weighted continuous ranked probability score (twCRPS))
- recently developed, user-focused scores and diagnostics including:
- threshold-weighted scores, such as threshold-weighted continuous ranked probability score (twCRPS) [(Gneiting and Ranjan 2011)](https://doi.org/10.1198/jbes.2010.08110) and threshold-weighted mean squared error (MSE) [(Taggart 2022)](https://doi.org/10.1002/qj.4206)
- Murphy diagrams [(Ehm et al., 2016)](https://doi.org/10.1111/rssb.12154)
- isotonic regression for reliability diagrams [(Dimitriadis et al., 2021)](https://doi.org/10.1073/pnas.2016191118)
Steph-Chong marked this conversation as resolved.
Show resolved Hide resolved
- statistical tests (e.g., the Diebold-Mariano ([Diebold & Mariano, 1995](https://doi.org/10.1080/07350015.1995.10524599)) test, with both the Harvey et al. ([1997](https://doi.org/10.1016/S0169-2070(96)00719-4)) and Hering & Genton ([2011](https://doi.org/10.1198/tech.2011.10136)) modifications).
- All scores and statistical techniques have undergone a thorough scientific and software review.
- An area specifically to hold emerging scores which are still undergoing research and development. This provides a clear mechanism for people to share, access and collaborate on new scores, and be able to easily re-use versioned implementations of those scores.
Expand Down
Loading