Improve user guide chapters on observables and constraints #4898
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make notation more consistent in particle-based observables. Move observable array shape from the constructor to the calculate() method (the constructor returns an object). Fix incorrect shape in the density profile observable. Distinguish vectors from scalars in the expressions for the single-particle force constraints. Increase runtime of the tutorial job in CI.
pm-blanco
approved these changes
Apr 2, 2024
reinaual
reviewed
Apr 3, 2024
reinaual
approved these changes
Apr 5, 2024
jngrad
pushed a commit
to jngrad/espresso
that referenced
this pull request
Apr 25, 2024
…d#4898) Fixes espressomd#4897 Description of changes: - fix issues in the description of observable return values and array shapes - fix vector notation in the expressions of single-particle force constraints - make notation more consistent across particle-based observables
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #4897
Description of changes: