search

m2lines / gz21_ocean_momentum

Stochastic-Deep Learning Parameterization of Ocean Momentum Forcing
MIT License
5 stars 0 forks source link

Rewrite readme #60

Closed raehik closed 1 year ago

raehik commented 1 year ago

The readme is in a bit of a state with lots of commands pointing to non-present files or incorrect URLs. Certain points like the dataset being stored in a Requester Pays GCP bucket went unexplained. This changeset replaces the readme for better clarity.

Slurm commands/notes are moved to a deprecated docs file, since we don't have the Slurm job scripts in this repo.

Some changes are already present in #50 , #54 . They will need rebasing after this merges.

raehik commented 1 year ago

Some problems addressed here are a result of attempting to onboard @MarionBWeinzierl .

raehik commented 1 year ago

@MarionBWeinzierl thx for the review. Clarified on most of the points you made. Some areas like memory usage/runtime and stage configuration I don't have enough insight on: in most cases I add a little bit of info to the readme, and where I don't know what to add I've provided context in the review comments.

With proper GH reviews, does the reviewer have to re-review after requesting changes? Simply marking all comments as resolved doesn't seem to change review status.

MarionBWeinzierl commented 1 year ago

Thanks a lot, @raehik . Yes, just click the circle-arrow next to my name in the reviewer field, that will re-request the review.