Skip to content

Add WRF build guide #177

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

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

Add WRF build guide #177

wants to merge 15 commits into from

Conversation

bcumming
Copy link
Member

@bcumming bcumming commented Jul 2, 2025

Add a section to the docs for building applications that are not in the list of supported software.

Add a first entry: https://docs.tds.cscs.ch/177/build-install/applications/wrf/#wrf

@bcumming bcumming requested review from msimberg and RMeli as code owners July 2, 2025 13:21
Copy link

github-actions bot commented Jul 2, 2025

preview available: https://docs.tds.cscs.ch/177

Copy link

github-actions bot commented Jul 2, 2025

preview available: https://docs.tds.cscs.ch/177

Copy link

github-actions bot commented Jul 4, 2025

preview available: https://docs.tds.cscs.ch/177

bcumming and others added 3 commits July 4, 2025 12:13
Co-authored-by: Rocco Meli <r.meli@bluemail.ch>
Co-authored-by: Rocco Meli <r.meli@bluemail.ch>
Co-authored-by: Rocco Meli <r.meli@bluemail.ch>
Copy link

github-actions bot commented Jul 4, 2025

preview available: https://docs.tds.cscs.ch/177

1 similar comment
Copy link

github-actions bot commented Jul 4, 2025

preview available: https://docs.tds.cscs.ch/177

In this example we use the latest version of `prgenv-gnu` on Eiger at the time of writing -- check the `prgenv-gnu` [guide][ref-uenv-prgenv-gnu] for the latest version.

```bash
# build the latest version provided by the version of Spack used by prgenv-gnu

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add $ cd ..

This comment has been minimized.

Copy link

preview available: https://docs.tds.cscs.ch/177

This comment has been minimized.

@msimberg
Copy link
Contributor

Unrecognized words (6)

commited
CRYOWRF
softare
steups
WRF
wrf

Some real typos in there, but for the stuff that you want to ignore: you can either simply ignore them (but they'll pop up again every time this page is touched in a PR) or you can add them to https://github.com/eth-cscs/cscs-docs/blob/main/.github/actions/spelling/allow.txt. I've been keeping them in alphabetical order. All lower-case words match any capitalization, at least one capital letter in the word will match only the given capitalization. In this case I think you might want to add wrf and cryowrf with any capitalization?

I will also add some notes on this to the contributing guide...

This comment has been minimized.

Copy link

preview available: https://docs.tds.cscs.ch/177

This comment has been minimized.

This comment has been minimized.

Copy link

preview available: https://docs.tds.cscs.ch/177

This comment has been minimized.

Copy link

preview available: https://docs.tds.cscs.ch/177

This comment has been minimized.

1 similar comment

This comment has been minimized.

Copy link

preview available: https://docs.tds.cscs.ch/177

Co-authored-by: Mikael Simberg <mikael.simberg@iki.fi>
Copy link

preview available: https://docs.tds.cscs.ch/177

Co-authored-by: Mikael Simberg <mikael.simberg@iki.fi>
Copy link

preview available: https://docs.tds.cscs.ch/177

1 similar comment
Copy link

preview available: https://docs.tds.cscs.ch/177

- 'Python with pip': build-install/pip.md
- 'Applications':
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seeing "Applications" in the navigation tree I would not necessarily expect to find this guide under that heading. What about using the title of the page, "Application installation guides"? Or "Application guides" like on the "Building and Installing software" index page?

Modern HPC applications and software stacks are often very complicated, and there is no one-size-fits-all method for building and installing them.
<div class="grid cards" markdown>

- :fontawesome-solid-earth-americas: __[Application guides][ref-build-applications]__ – guides on how to install commonly requested or difficult to install software.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- :fontawesome-solid-earth-americas: __[Application guides][ref-build-applications]__ – guides on how to install commonly requested or difficult to install software.
- :fontawesome-solid-earth-americas: __[Application guides][ref-build-applications]__ – guides on how to install commonly requested or difficult to install, but not officially supported, software.

or something in that direction?

Copy link
Contributor

@msimberg msimberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple of questions/suggestions. No comments on the guide itself, mostly wondering about what the best name for that "Application guides" section is, without giving users the impression that they are officially supported.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants