Skip to content
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

Add instructions for building within CESM, linking to FTorch, and running. #5

Open
wants to merge 7 commits into
base: datawave_ml
Choose a base branch
from

Conversation

jatkinson1000
Copy link
Member

@jatkinson1000 jatkinson1000 commented Apr 22, 2024

Closes #6
Relates to #1, #2

I have added instructions for

  • obtaining CESM and checking out the relevant tag (2.1.5 tbc with Joan/Qiang)
  • pointing to use this fork of CAM as part of CESM build
  • pointing to the ICCS fork of CIME as part of the CESM build
    • minimal instructions/notes about building FTorch
  • Building and running

Possible TODO:

  • Specify which variables to add to the fincl files.
    Though perhaps this will come in a later PR as we modify the code and add these?

@jatkinson1000 jatkinson1000 added documentation Improvements or additions to documentation Fortran This is an issue on the Fortran/CAM side of the coupling project labels Apr 22, 2024
@jatkinson1000 jatkinson1000 self-assigned this Apr 22, 2024
@jatkinson1000 jatkinson1000 mentioned this pull request Aug 19, 2024
3 tasks
* docs: update installation instructions for CAM with FTorch

* docs: update FTorch build instructions in README.md

Co-authored-by: Jack Atkinson <109271713+jatkinson1000@users.noreply.github.com>

* docs: fix typo in README.md

Co-authored-by: Jack Atkinson <109271713+jatkinson1000@users.noreply.github.com>

* docs: better explanation of `DOUT_S` xml parameter

Co-authored-by: Jack Atkinson <109271713+jatkinson1000@users.noreply.github.com>

* docs: correct explanation of setting `DOUT_S=FALSE`

Co-authored-by: Jack Atkinson <109271713+jatkinson1000@users.noreply.github.com>

* docs: better description of CAM version specifics

Co-authored-by: Jack Atkinson <109271713+jatkinson1000@users.noreply.github.com>

* docs: remove unnecessary info about libtorch module

* docs: add more description to the NN configuration

---------

Co-authored-by: Jack Atkinson <109271713+jatkinson1000@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Fortran This is an issue on the Fortran/CAM side of the coupling project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for building and running
3 participants