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

Document how to run a simple example using regression test case data #1130

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

neumantm
Copy link
Contributor

@neumantm neumantm commented Feb 7, 2023

This is useful to quickly check if the installation of nalu-wind works.

This was inspired by a comment by @psakievich

This is useful to quickly check if the installation of nalu-wind works
@jrood-nrel
Copy link
Contributor

Maybe we don't have enough documentation on it, but using ctest is the preferred method to run the regression tests.

@neumantm
Copy link
Contributor Author

neumantm commented Feb 8, 2023

Yes I understood this.
The goal of this is to document how to (mis)use a regression test case as a very simple example to see if the installation works.
That is what @psakievich suggested in the comment I linked.
Maybe I should change the title of the PR.

@neumantm neumantm changed the title Add documentation on how to run a regression test case Document how to run a simple example using regression test case data Feb 8, 2023
@psakievich
Copy link
Contributor

@neumantm would you also add in an example of running the unittests? I think my preference for people testing the code is first to run the unit tests and then they can manually run the regression tests. We always build the unit tests right now, and as a plus they don't require the mesh repo which is 600MB (recently down from 1GB thanks to @jrood-nrel 🙏)

@neumantm
Copy link
Contributor Author

Sure. Makes sense.
They just need to run unittestX, am I right?

@psakievich
Copy link
Contributor

@neumantm yes that is correct.

@psakievich psakievich enabled auto-merge (squash) April 8, 2023 20:59
@psakievich psakievich disabled auto-merge April 8, 2023 21:01
@psakievich psakievich enabled auto-merge (squash) April 8, 2023 21:01
@psakievich psakievich closed this Apr 8, 2023
auto-merge was automatically disabled April 8, 2023 21:01

Pull request was closed

@psakievich psakievich reopened this Apr 8, 2023
@psakievich psakievich enabled auto-merge (squash) April 8, 2023 21:01
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.

None yet

3 participants