ESMCI / cime

Common Infrastructure for Modeling the Earth
http://esmci.github.io/cime
Other
161 stars 207 forks source link

Questions about versions, docs, and testing, and advice for porting #4695

Closed jatkinson1000 closed 1 week ago

jatkinson1000 commented 1 week ago

Hi There,

I am working to port CIME to a new machine. I have made a fair bit of progress but am now a bit stuck and had some questions I hope you can help with.

In reality the aim is to port CESM 2.x, for which I need to port CIME. My main question is what version/tag/release/commit should I branch from? It looks like there is currently a major refactor to version 6 going on in the master branch, but from what I can tell versions 5.6 and 5.8 are still maintained and used. The Externals.cfg files from CESM tags I want to use often point to different tags of CIME, so I wondered where would be a sensible place to branch from?

Related to this - will CIME v6 be backwards compatible to older versions of CESM? Would it make sense to work with v6, or start with v5?

Looking at the documentation here: https://esmci.github.io/cime/versions/master/html/users_guide/porting-cime.html the advice for running tests seems to differ from the wiki here: https://github.com/ESMCI/cime/wiki/Testing I ran the regression tests from the python script CIME/tests/scripts_regression_tests.py, but now want to explore the ones that fail in detail by running a category or specific test following the instructions here but when I look I cannot find the files CIME/tests/test_unit*

Is there different documentation available for the different versions of CIME? I can only see master at https://esmci.github.io/cime/ though it seems this is a v5 set of docs rather than the WIP v6 on master? Would you be able to clarify which versions of CIME the webdocs and wiki relate to?

For reference I have been working with tag cime5.6.49 which came from the CESM tag cesm2.1.5, but this was a somewhat arbitrary starting point and your advice is appreciated.

Thank you in advance for your help, and my apologies if I missed something obvious somewhere.

jedwards4b commented 1 week ago

This type of question should be posted to the cesm forum and not a github issue. Please navigate to the [forum] (https://bb.cgd.ucar.edu/cesm) and I will answer your questions there. Thanks

jatkinson1000 commented 1 week ago

Apologies and thank you. I have done this here: https://bb.cgd.ucar.edu/cesm/threads/porting-cesm-cime-version-to-use-and-appropriate-documentation-testing.10134/