Case creation in the NorESM documentation

[TimotheeBrgs]

In this page of the NorESM documentation explaining how to create a case, the following is suggested:
./create_newcase --case ../../cases/$CASENAME --mach $MACHINE --res f19_tn14 --compset $COMPSET

The above command implies that the cases directory is at the same level as the component directory for example.

It seems that the common practice among NorESM developers is to have the cases directory one level below the <noresm-base>, such as:
./create_newcase --case ../../../cases/$CASENAME --mach $MACHINE --res f19_tn14 --compset $COMPSET

I suggest giving examples of common practices.

[adagj]

Sure! We should change that. Maybe even better to add path to cases folder or something like that. I also think the case name is not in line with what is commonly used. The person who wrote this guide has left, but I can have a look later this week and make a new version. I'll add you as a reviewer so you can comment further. Or if you want to modify it, feel free to do so :)

[TimotheeBrgs]

I am happy to contribute. I tried to follow the instructions from README.md but I cannot propose changes.

[adagj]

@MichaelSchulzMETNO can you add @TimotheeBrgs to the documentation group? Or provide permissions somehow :)

[MichaelSchulzMETNO]

Hi Timothee, you should now be able to contribute and make pull requests. Please try

[TimotheeBrgs]

Hi Michael, I received an invitation to be a contributor of the NorESMhub/NorESM. I accepted. Thank you for that. I see now pull requests. I will try to make a pull request another time since Ada has already included my suggestion. Thank you again.

[adagj]

@TomasTorsvik
Hi Tomas,
I try to make the newbies guide more consistent, but I have some questions which maybe you can answer.... it seems like we use a mix of <> and $ , e.g. <casename> vs. $CASENAME . I guess it reflects different authors, you belonging to the first category and I the last :-) Should we decide on one syntax?

[TomasTorsvik]

Yes, that would probably be nice to do. The way I see it, $CASENAME can be ambiguous, because the the format is used for shell variables. I think it makes sense to reserve this format for the case that we really mean to reference a shell variable (e.g. $USERWORK to reference the work area on Fram and Betzy). The <casename> format for placeholder is a fairly common convention, but there may be other conventions as well. I didn't look into this very much.

In some cases the $CASENAME may be an actual variable name, and in those cases we should definitely keep the $ format.

[adagj]

#363