Update README.md to specify MOM6 version requirements and configuration

[ashjbarnes]

closes #87

[ashjbarnes]

Just thought I'd get your opinion as to whether this approach makes sense. The package itself doesn't care about the version used (afaik) but the demo notebooks do

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (68646e4) 61.02% compared to head (3a7c638) 61.02%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #90   +/-   ##
=======================================
  Coverage   61.02%   61.02%           
=======================================
  Files           3        3           
  Lines         544      544           
=======================================
  Hits          332      332           
  Misses        212      212           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[navidcy]

OK, fair point!

Then let's be a bit more specific.

• Let's avoid "as of January 2024". These statements become outdated... The commit anyway comes with a timestamp so everyone knows when the latest README was written.
• Let's not say which versions won't work, e.g., "the source code from here will not necessarily work."
• Let's just say which versions work. E.g., "`regional-mom6 requires you to build mom6 executable from commit XXX"

[navidcy]

Also regarding:

While the underlying package should work for coupled or ocean only configurations, the premade files for the demos are written for a coupled MOM6-SIS2 configuration.

Do we know for sure that it should work for coupled or ocean only configurations? Have we ever tested it? Let's not hypothesise if not. It's cleaner if we say

All demos and tests were conducted for a coupled MOM6-SIS2 configuration. In principle, regional-mom6 could also work for coupled or ocean-only MOM6 configurations, but we have not tested it.

Also, what is the difference of "coupled" and "coupled MOM6-SIS2"?

[ashjbarnes]

* Let's just say which versions work. E.g., "`regional-mom6 requires you to build mom6 executable from commit XXX"

I'd rather not do this as it'll clutter up the readme a lot given there are many required packages. The link to my repo and the src directory there should be sufficient

[ashjbarnes]

* Let's avoid "as of January 2024". These statements become outdated... The commit anyway comes with a timestamp so everyone knows when the latest README was written.

Yes but if we update another part of the readme then the timestamp will change and readers shouldn't then assume that the 'latest' source code refers to that timestamp. I think this way is clearest for now, especially with the link to the src directory of commits.

[navidcy]

* Let's just say which versions work. E.g., "`regional-mom6 requires you to build mom6 executable from commit XXX"

I'd rather not do this as it'll clutter up the readme a lot given there are many required packages. The link to my repo and the src directory there should be sufficient

I only meant to write explicitly the versions of dependencies that cannot be properly added as package dependencies.

[navidcy]

OK, I only now realized that your repo listed all the commits used to compile MOM6 and its subcomponents.

I rephrased a bit. I think it's good now! It provides the info needed!