-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update installation instructions for CAM with FTorch #19
docs: update installation instructions for CAM with FTorch #19
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good Tom. The changes make sense and add to readability and comprehension me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @TomMelt
I have left a few suggestions/comments.
My overall impression after reading this is that the ### Obtaining FTorch
section now feels quite empty. I wonder if there is some reshuffling that could make this easier to follow.
I'm happy for this to be my responsibility, as I realise this is a PR onto my PR, so the buck eventually stops with me.
I also note that on reading it is some time since I wrote these instructions (due to the delays in receiving a review (not from yourself!!)) and there are things I would do differently after working on the project for some time.
So, I'm keen to get this merged and then have a second pass through myself, so feel free to comment in #5 to make some of the points tasks for me to do.
Co-authored-by: Jack Atkinson <[email protected]>
Co-authored-by: Jack Atkinson <[email protected]>
Co-authored-by: Jack Atkinson <[email protected]>
Co-authored-by: Jack Atkinson <[email protected]>
Co-authored-by: Jack Atkinson <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is at a point where we should merge, and make further adjustments in the host PR.
Thanks @TomMelt
* docs: update installation instructions for CAM with FTorch * docs: update FTorch build instructions in README.md Co-authored-by: Jack Atkinson <[email protected]> * docs: fix typo in README.md Co-authored-by: Jack Atkinson <[email protected]> * docs: better explanation of `DOUT_S` xml parameter Co-authored-by: Jack Atkinson <[email protected]> * docs: correct explanation of setting `DOUT_S=FALSE` Co-authored-by: Jack Atkinson <[email protected]> * docs: better description of CAM version specifics Co-authored-by: Jack Atkinson <[email protected]> * docs: remove unnecessary info about libtorch module * docs: add more description to the NN configuration --------- Co-authored-by: Jack Atkinson <[email protected]>
Hi @jatkinson1000 , here's my take on the build instructions.
There's no major differences. I just tried to align it with the steps I actually used to build the code. Biggest one is probably that I removed running
module load libtorch
because it conflicts with the basencarenv/23.06
module, and we don't actually need to load it. I did add an explanation though as to why it's been removed.One thing I realised in the process though is the description for the xml vars
gw_convect_dp_ml_net_path
andgw_convect_dp_ml_norms
possibly needs updating. Am I right in thinking that even ifgw_convect_dp_ml
is set to.false.
, ifgw_convect_dp_ml_compare
is.true.
do we not run both models anyway. For this README I took the definitions of the variables frombld/namelist_files/namelist_definition.xml
.Here's the relevant section from
bld/namelist_files/namelist_definition.xml
.Let me know what you think 👍
(I wouldn't normally tag all of you in the review, I just thought you might like to see the build instructions. Probs just @j-emberton and @jatkinson1000 that need to approve)