search

idaholab / MontePy

MontePy is the most user friendly Python library (API) to read, edit, and write MCNP input files.
https://www.montepy.org/
MIT License
32 stars 7 forks source link

Run Examples in CI #575

Closed tjlaboss closed 1 week ago

tjlaboss commented 1 month ago

Is your feature request related to a problem? Please describe. Example code is not tested automatically. It can fall out of date without anyone noticing, or it might not run out of the box.

Describe the solution you'd like During CI, add an example-test that at least makes sure that the examples and demos execute.

Additional context In #571, a demo does run without manual intervention.

In #559, @MicahGale suggests adding doctest, which is relevant.

MicahGale commented 1 month ago

So what's the scope?

  1. README.md
  2. /doc
  3. /demo?

Also most examples are pseudo-code, so this will take a little bit of effort to implement.