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 of bad practice should be removed from sample scripts #94

Open
kosovan opened this issue Sep 13, 2024 · 0 comments
Open

examples of bad practice should be removed from sample scripts #94

kosovan opened this issue Sep 13, 2024 · 0 comments
Labels

Comments

@kosovan
Copy link
Collaborator

kosovan commented Sep 13, 2024

The following issues should be removed from all sample scripts (if still present).
Otherwise, beginners copy the sample scripts, adopt them for their system, and use the bad practice in their production scripts.

  • The observable time series should be saved in an observable file and processed independently after the simulation, not on the fly.
  • The equilibration time time is not known beforehand. Therefore, full observable time series should be saved.
  • Running a set of simulations at different conditions (e.g. different pH values) within a single script is not advisable
  • The nomenclature step and sample is used ambiguously and inconsistently
  • All independent input parameters should be set within a single block of code, not scattered through the whole script
  • Post-processing the time series, merging and plotting the results from multiple simulations should be a separate example
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants