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

Automatically update examples #165

Open
nichollsh opened this issue Aug 31, 2024 · 6 comments
Open

Automatically update examples #165

nichollsh opened this issue Aug 31, 2024 · 6 comments
Labels
enhancement New feature or request JOSS publication: PROTEUS TBD before PROTEUS JOSS publication Priority 3: standard Priority level 3: medium time criticality or importance software Relating to software and implementation

Comments

@nichollsh
Copy link
Contributor

It is useful to store example results for several reasons:

  • when demonstrating what the model can do
  • knowing what sort of thing to expect when running the model
  • comparison with previous results following changes to the model
  • sanity checks

There are currently two examples, which I ran manually from the 'default' and 'dummy' configs, and then copied to the examples folder with 'tools/MakeExample.sh`. However, they are now out of date.

It would be better if these examples were automatically updated. This could potentially operate via a GitHub action, triggered when a release is created.

@nichollsh nichollsh added the enhancement New feature or request label Aug 31, 2024
@nichollsh
Copy link
Contributor Author

A prerequisite for this is to have PROTEUS running via GitHub actions. This should be done through a separate issue, and is also related to implementing some more tests.

@stefsmeets
Copy link
Contributor

Can't do this on the main branch because of branch protection.

@nichollsh
Copy link
Contributor Author

As in, because we require changes to be made through a PR?

@stefsmeets
Copy link
Contributor

Yeah, exactly

@nichollsh
Copy link
Contributor Author

Makes sense. Maybe in we could consider having the model run examples and package them as an artefact? Particularly if the examples are only to be run when a release is generated. Would this have permissions issues?

@stefsmeets
Copy link
Contributor

I'm not entirely sure how that would work, artifacts are not great to work with (they are more of a developer thing) and you cannot link them directly, which is a major bottleneck.

@lsoucasse lsoucasse added the software Relating to software and implementation label Nov 11, 2024
@timlichtenberg timlichtenberg added Priority 3: standard Priority level 3: medium time criticality or importance JOSS publication: PROTEUS TBD before PROTEUS JOSS publication labels Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request JOSS publication: PROTEUS TBD before PROTEUS JOSS publication Priority 3: standard Priority level 3: medium time criticality or importance software Relating to software and implementation
Projects
Status: JOSS Publication
Development

No branches or pull requests

4 participants