search

rigoudyg / climaf

CliMAF - a Climate Model Analysis Framework - doc at : http://climaf.readthedocs.org/
Other
16 stars 7 forks source link

Update default documentation, and improve usage on spirit ( and spiritx ?) #249

Open jypeter opened 1 year ago

jypeter commented 1 year ago

When you visit the documentation page (https://climaf.readthedocs.io/), you still get 2.0.0 documentation. Should we get 3.0 documentation by default now?

I manually switched to the 3.0 documentation in order to find out if there were some instructions to use CliMAF on spirit(x?), but there is still nothing...

Maybe people are still supposed to remember an October 2022 mail, but that's not very convenient... It would ideally be nice to have CliMAF directly listed in the available modules, which is not the case yet

The following worked on spirit, and I was able to use my existing script

jypmce@spirit1:~$ module load climaf
ERROR: Unable to locate a modulefile for 'climaf'

jypmce@spirit1:~$ module avail -l | grep -i maf

jypmce@spirit1:~$ ls -ltr /net/nfs/tools/Users/SU/modulefiles/jservon/climaf/
[...]
-rw-rw-r-- 1 ssenesi ext      1603 Jun 11 17:08 env20230611_climafV3.0

jypmce@spirit1:~$ module load /net/nfs/tools/Users/SU/modulefiles/jservon/climaf/env20230611_climafV3.0

jypmce@spirit1:~$ which python
/net/nfs/tools/Users/SU/jservon/spirit-2021.11_envs/20230611/bin/python
rigoudyg commented 1 year ago

Hello,

The default documentation should be the V3.0 one. But it seems to have issues with browser cache. I had to reload the page to find out the new documentation.

For instructions concerning spirit(x), they are about to be given and the documentation will be updated once they are available.

Best regards, Gaëlle