Update README structure #55
Conversation
| </p> | ||
|
|
||
| Spinup-Evaluation was developed to assess the DINO configuration of NEMO, but new metrics can be added to metrics.py to make it compatible with any ocean model. See [Adding New Metrics](#adding-new-metrics) for details. | ||
| ## Using Spinup Evaluation |
There was a problem hiding this comment.
Can you keep this named Usage? Also, even though the text is valid, perhaps we should keep the README as brief and succinct as possible - the RTD will contain more helpful info to use the tool, much like weatherbench2.
ma595
left a comment
ma595
left a comment
There was a problem hiding this comment.
Thanks @surbhigoel77, this is coming together nicely. A few suggestions as discussed yesterday:
- Update the README in line with tag v0.0.1. I.e. the API. #46
- Check spelling in places.
- Keep the README quite short - it's an entrypoint to the tool, RTD will contain more information (i.e. on how to add new metrics). We can reference this in the README, but no more. See Weatherbench2.
- Remove the tree repo structure.
- Quick mention of running tests (when they exist).
- Separately we need to start a
Contributing.md - I was going to suggest merging in the diagram from #31, but I don't think it's valid anymore. We need to think about how to demonstrate the tool pictorially. Suggestions welcome.
| ## Command line scripts | ||
|
|
||
| ## Installation | ||
| ### Installing Spinup Evaluation |
There was a problem hiding this comment.
As previous, keep this named Installation and keep at the same level as before. This should appear before Usage .
| # Configure pre-commit hooks | ||
| pre-commit install | ||
| ``` | ||
| ### Running on Saved Restart File |
| --output <path-to-output> | ||
| ``` | ||
|
|
||
| ### Running on Predictions [TODO] |
There was a problem hiding this comment.
The use of the code has now changed regarding #46. Also, we don't run on predictions anymore.
There was a problem hiding this comment.
well, we do, but these are as the restart files.
| <!-- >  --> | ||
|
|
||
|
|
||
| ## Adding New Metrics |
There was a problem hiding this comment.
I'd avoid putting this in the README. Better to have it in the RTD.
|
Self note for @surbhigoel77:
|
Fixes #49 #50