Sorcha/dev/1696 - #2630
Conversation
* testing layout * trying at root of repo * adding onf * new docs * adding .rst files
Updated paths and instructions for template files and score computation.
Updated the output directory and template folder paths to use environment variable placeholders for better flexibility.
github-actions
Bot
added
the
eval
tjhunter
left a comment
tjhunter
left a comment
There was a problem hiding this comment.
@enssow (cc @iluise ): the docs look good, thank you for putting it together. All the important pieces are there.
One change breaks the uv packaging (moving README), the other comments are more details. As you noted, it is hard to use without an example, but I would not prioritize it: the fast-eval package is tied to running weathergen, and only the people in the consortium can currently run weathergen.
I would focus first on:
- more general explanations on running end to end weathergen before more efforts on the eval doc.
- automating checks on the json/yaml config schema: it is becoming long and complex, and the doc will fast misalign with the code.
| name: readthedocs | ||
| locale: en | ||
| highlightjs: true | ||
| # font: |
There was a problem hiding this comment.
remove the commented parts
| build: | ||
| os: "ubuntu-22.04" | ||
| tools: | ||
| python: "3.11" |
There was a problem hiding this comment.
can you make it python 3.12 like the rest of the project?
There was a problem hiding this comment.
can it be symlink'ed from the root of the project rather than copied?
There was a problem hiding this comment.
I am confused why we still have this file, if the rest is moved inside package/evaluate
| ## Input | ||
|
|
||
| The `WeatherGenerator-FastEvaluation` package supports multiple inputs: | ||
| - The WeatherGenerator `.zarr` files generated by the inference step of the WeatherGenerator chain. It reads both `Target` and `Prediction` from local files (`WeatherGenReader`). |
There was a problem hiding this comment.
missing new line, this is not rendering as a list
|
|
||
| The default config file is at: `WeatherGenerator/configs/evaluate/eval_config.yml` | ||
|
|
||
| More instructions can be found here: https://gitlab.jsc.fz-juelich.de/esde/WeatherGenerator-private/-/wikis/home/Common-workflows/fast-evaluation |
There was a problem hiding this comment.
this link is not a link in the final doc. Also, this is for the private wiki, it does not fit in public documentation (or it should be marked as private)
|
|
||
| nav: | ||
| - "Introduction": README.md | ||
| - "Configuration File": guide/config.md |
There was a problem hiding this comment.
"Configuration reference"
There was a problem hiding this comment.
you cannot move the file, it is required by uv to make a package (it is a python package requriment). However, you can create a symbolic link, which git will properly register.
There was a problem hiding this comment.
make sure to have an operating procedure with the command that you ran to update this file.
4 participants
Description
Read the Docs working implementation, to be moved to ecmwf/develop so it can be udpated when eval code is changed.
Issue Number
Closes #1696
Closes #2611
Checklist before asking for review
./scripts/actions.sh lint./scripts/actions.sh unit-test./scripts/actions.sh integration-testlaunch-slurm.py --time 60