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

Documentation needs more information about the "quickbuild nompi" option #497

Closed
mjs2369 opened this issue Jun 21, 2023 · 1 comment · Fixed by #562
Closed

Documentation needs more information about the "quickbuild nompi" option #497

mjs2369 opened this issue Jun 21, 2023 · 1 comment · Fixed by #562
Assignees
Labels
Documentation Improvements or additions to documentation Good First Issue Good for newcomers

Comments

@mjs2369
Copy link
Contributor

mjs2369 commented Jun 21, 2023

Our SIParCS students ran into the same issue when building and running lorenz_63 with DART for the first time. This was that they tried to run filter after running "quickbuild.sh" without having an MPI library available on their local machines, so it failed.

The way to fix this is to simply add "nompi" to the quickbuild command, but this was not apparent to our students working off our guide to compiling DART (https://docs.dart.ucar.edu/en/latest/guide/compiling-dart.html), which makes no mention of it.

While the option is discussed in the "quick-start" section of the home page ([https://docs.dart.ucar.edu/en/latest/README.html#quick-start]
(https://docs.dart.ucar.edu/en/latest/README.html#quick-start)), it can easily be missed here.

edit README.html is now index.html
https://docs.dart.ucar.edu/en/latest/index.html#quick-start

This will be a really simple documentation fix that will add some basic information on how to use the "quickbuild nompi" option to the pages that are needing it:
https://docs.dart.ucar.edu/en/latest/guide/compiling-dart.html
https://docs.dart.ucar.edu/en/latest/guide/quickbuild.html#dart-build-system

This will just make this option a little more obvious to our users, especially those building DART for the first time.

Using DART v10.7.3

@mjs2369 mjs2369 added Documentation Improvements or additions to documentation Good First Issue Good for newcomers labels Jun 21, 2023
@mjs2369 mjs2369 changed the title Documentation needs more information about the quickbuild options Documentation needs more information about the "quickbuild nompi" option Jun 21, 2023
@hkershaw-brown
Copy link
Member

@c-merchant how is this going? Ready for a pull request?

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 Good First Issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants