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

Examples should run entirely by default unless flags are given #178

Closed
FabienPean-Virtonomy opened this issue Dec 9, 2022 · 0 comments · Fixed by #424
Closed

Examples should run entirely by default unless flags are given #178

FabienPean-Virtonomy opened this issue Dec 9, 2022 · 0 comments · Fixed by #424
Labels
enhancement New feature or request

Comments

@FabienPean-Virtonomy
Copy link
Collaborator

Following up the live discussion: the way program options are handled should be modified. Examples without program options should run the whole sequence, while flags allows to specify specific behavior.

./example # should run particle generation/relaxation + timeloop
./example -r=true # should run just generation/relaxation
./example -i=true # should just reload

Program options should also be following more standard format with dash followed by single letter and double-dash followed by whole words. Since sphinxsys has 3 options that starts with R, it would be preferable to only allow whole word writing to avoid confusion and error.

./example --relax 
./example --reload 
./example --restart

Effects:

  • Easier for newcomer to test examples
  • Can simplify several CMakeLists by reducing duplication
@Xiangyu-Hu Xiangyu-Hu added the enhancement New feature or request label May 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants