Skip to content

Updating Examples in Documentation#2185

Merged
joaander merged 18 commits intoglotzerlab:trunkfrom
jaronoff14:update-docs
Feb 19, 2026
Merged

Updating Examples in Documentation#2185
joaander merged 18 commits intoglotzerlab:trunkfrom
jaronoff14:update-docs

Conversation

@jaronoff14
Copy link
Contributor

@jaronoff14 jaronoff14 commented Nov 24, 2025

Description

Updated the example in integrate.py to comply with the current hoomd syntax and converted examples in hoomd/md so that they are tested with Sybil

Motivation and context

The old example in integrate.py was from an older version of hoomd and the syntax was not functional in the current version of hoomd

Partially Resolves #1958
I am not sure if this catches all of the old examples

How has this been tested?

The example in integrate.py was tested by following the tutorials in a jupyter notebook.
The sphinx documentation was rebuilt.

Checklist:

  • [ x] I have reviewed the Contributor Guidelines.

  • [x ] I agree with the terms of the HOOMD-blue Contributor Agreement.

  • My name is on the list of contributors (sphinx-doc/credits.rst) in the pull request source branch.

  • I have summarized these changes in CHANGELOG.rst following the established format.

@github-actions
Copy link

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@github-actions github-actions bot added the stale There has been no activity on this for some time. label Dec 15, 2025
@joaander joaander removed the stale There has been no activity on this for some time. label Dec 16, 2025
@joaander
Copy link
Member

Sorry for the delay, I will review this soon.

@github-actions
Copy link

github-actions bot commented Jan 5, 2026

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@github-actions github-actions bot added the stale There has been no activity on this for some time. label Jan 5, 2026
@joaander joaander removed the stale There has been no activity on this for some time. label Jan 6, 2026
@github-actions
Copy link

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@github-actions github-actions bot added the stale There has been no activity on this for some time. label Jan 26, 2026
@joaander joaander removed the stale There has been no activity on this for some time. label Jan 26, 2026
@github-actions
Copy link

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@github-actions github-actions bot added the stale There has been no activity on this for some time. label Feb 16, 2026
@joaander joaander removed the stale There has been no activity on this for some time. label Feb 17, 2026
Copy link
Member

@joaander joaander left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! And sorry for the long delay before reviewing this.

I pushed commits that fix the errors in all the code examples that are tested by this PR. I am going to merge now so that I can include this in the next release. However, I would still like to add your name and affiliation to credit your contribution. Let me know that information in a comment and I will add it to the documentation.

@joaander joaander merged commit a259342 into glotzerlab:trunk Feb 19, 2026
35 checks passed
@jaronoff14
Copy link
Contributor Author

No worries on the delay.
Jon Aronoff, University of Utah

@joaander
Copy link
Member

Thanks again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Convert remaining examples to Sybil

2 participants