HPC-Stack Documentation #385
Conversation
|
@gspetro-NOAA I see the SRW installation guideline at /docs/INSTALL. |
There was a problem hiding this comment.
Thank you for your contribution.
I have a few comments:
- Would you suggest removal or thinning down of the
README.mdso that same/similar information does not reside in 2 places. This will make it easier to update in a single location. - Would it be possible to deploy this documentation on github pages and have it auto-generated via a github action upon merge to develop? I am not familiar with how sphinx generates the html, but I imagine it would be possible.
- Please see specific comments in the review.
|
It should also be noted that we are transitioning from hpc-stack to a spack-based solution. |
|
Do you just mean that I should be aware of the transition or that I should note it in the docs? If you would like it mentioned in the docs, where do you suggest mentioning it? I am aware that we'll be switching to spack-based installation, but my understanding is that it will not be fully tested and ready for the upcoming SRW release. Therefore, these instructions will need to be included in the SRW release at a minimum and also possibly in the MRW release depending on how the timing works out. |
|
No, I wasn't suggesting that it appear in the docs, just that it be born in mind. |
| .. warning:: | ||
| The HPC-stack is already installed on `Level 1 systems <https://github.com/ufs-community/ufs-srweather-app/wiki/Supported-Platforms-and-Compilers>`_ (e.g., Cheyenne, Hera, Orion). Installation is not necessary. | ||
|
|
||
| HPC-Stack installation will vary from system to system because there are so many possible combinations of operating systems, compilers, MPI's, and package versions. Installation via an EPIC-provided container is recommended to reduce this variability. However, users may choose a non-container approach to installation if they prefer. |
There was a problem hiding this comment.
Added a definition of MPI, just fyi. :)
|
Just wanted to check in and see (1) whether any more edits are required and (2) if not, what the timeline for the merge would look like. I believe I've incorporated all of the requested changes, and I did a thorough revision today to check on any remaining formatting errors, typos, and tweaks. You can view the most updated version of the docs here. As @jkbk2004 mentioned, once the request is merged, I can change the webhook on my readthedocs.org account to pick up EMC/hpc-stack official version. Alternatively, if there is an EMC readthedocs.org account, the hpc-stack docs could be added to that. |
|
This looks really cool. Thanks for the work. I'm going to try building the docs. |
|
Going to merge #394 and then I'll merge this |
Add Sphinx docs to hpc-stack
DESCRIPTION OF CHANGES:
Added Sphinx documentation that can be integrated into upcoming SRW (& eventually MRW) release documentation. This will allow users of these applications to remain within the application's documentation instead of switching between sets of docs (e.g., SRW & HPC-Stack). Updating the documentation exclusively with the HPC-Stack and then including it as a submodule in various applications (e.g., SRW, MRW) will streamline management of the documentation.
ISSUE:
Fixes issue mentioned in #384.
CONTRIBUTORS (optional):
@gspetro-NOAA @jkbk2004 @EdwardSnyder-NOAA @trihug @mark-a-potts @laurenfrederick