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

Sanity check examples to be packaged with binary distribution #272

Closed
wants to merge 3 commits into from

Conversation

mayantaylor
Copy link
Collaborator

@mayantaylor mayantaylor commented Sep 5, 2024

I'm adding a set of examples that can be run via a command line interface after installing Charm4py from a binary distribution. These examples were copied from the examples folder.

TODO:

  • I'm unsure if this is the best directory structure. Putting minitest inside of the charm4py module causes the following warning to be printed after any minitest: Program is exiting but charm was not started: charm.start() was not called or error happened before start As is, minitest cannot be placed inside tests because tests is not a module.
  • Also, I'm not sure about the naming of various things (minitest, charm4py_test, etc). Open to feedback!
  • Should more options be provided at CLI? Should ++local be forced?

Copy link
Contributor

@adityapb adityapb left a comment

Choose a reason for hiding this comment

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

The directory structure looks fine to me. The purpose of this is to be able to quickly check if the installation worked, right?

TIMEOUT = 120 # timeout for each test (in seconds)

cmd = ["charmrun"]
cmd += ['++local']
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we only distributing the netlrts build with pip? What happens if you run with ++local with the MPI build?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

the pip binaries only include the netlrts build

@mayantaylor mayantaylor marked this pull request as ready for review September 10, 2024 12:33
@matthiasdiener
Copy link
Contributor

I'm not 100% sure if these extra examples are really necessary - could they be confusing for the user? Could we tell the user something like:

In order to test your charm4py installation, run:
$ python examples/simple/hello_world.py

@mayantaylor mayantaylor deleted the maya/minitest branch September 11, 2024 14:04
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.

3 participants