Skip to content

Fix typo in docs #2138

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.

Sign up for GitHub

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

Draft
wants to merge 7 commits into
base: trunk-patch
Choose a base branch
from
Draft

Fix typo in docs #2138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ec99257
Update __init__.py
janbridley Oct 3, 2025
d3a9628
Update other typos
janbridley Oct 3, 2025
6a26d7c
Fix one more
janbridley Oct 3, 2025
4eaac1f
Address style comment
janbridley Oct 3, 2025
406c687
Fix style
janbridley Oct 3, 2025
3c00306
Fix typo
janbridley Oct 3, 2025
542cf51
Update hoomd/md/external/wall.py
janbridley Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion hoomd/hpmc/external/external.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def energy(self):

.. math::

U = \\sum_{i=0}^\\mathrm{N_particles-1}
U = \\sum_{i=0}^{N_\\mathrm{particles}-1}
U_{\\mathrm{external},i}

See `hoomd.hpmc.integrate` for the full expression which includes
Expand Down
2 changes: 1 addition & 1 deletion hoomd/hpmc/integrate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@
.. math::

U_\mathrm{external} =
\sum_{i=0}^\mathrm{N_particles-1} U_{\mathrm{external},i}(\vec{r}_i,
\sum_{i=0}^\mathrm{N_{particles}-1} U_{\mathrm{external},i}(\vec{r}_i,
\mathbf{q}_i)

Potential classes in `hoomd.hpmc.pair` evaluate
Expand Down
4 changes: 2 additions & 2 deletions hoomd/hpmc/pair/pair.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ def energy(self):

.. math::

U = \\sum_{i=0}^\\mathrm{N_particles-1}
\\sum_{j=i+1}^\\mathrm{N_particles-1}
U = \\sum_{i=0}^{N_\\mathrm{particles}-1}
\\sum_{j=i+1}^{N_\\mathrm{particles}-1}
U_{\\mathrm{pair},ij}

See `hoomd.hpmc.integrate` for the full expression which includes
Expand Down
2 changes: 1 addition & 1 deletion hoomd/md/external/wall.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

.. math::

U_\mathrm{wall} = \sum_{i=0}^{\mathrm{N_particles-1}}
U_\mathrm{wall} = \sum_{i=0}^{N_\mathrm{particles}-1}
\sum_{w \in walls} U_w(d_i),

where :math:`d_i` is the signed distance between particle :math:`i` and the wall
Expand Down
2 changes: 1 addition & 1 deletion hoomd/md/integrate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ def linear_momentum(self):

.. math::

\\vec{p} = \\sum_{i=0}^\\mathrm{N_particles-1} m_i \\vec{v}_i
\\vec{p} = \\sum_{i=0}^{N_\\mathrm{particles}-1} m_i \\vec{v}_i
"""
v = self._cpp_obj.computeLinearMomentum()
return (v.x, v.y, v.z)
2 changes: 1 addition & 1 deletion hoomd/md/many_body.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

.. math::

U_\mathrm{many-body} = \frac{1}{2} \sum_{i=0}^\mathrm{N_particles-1}
U_\mathrm{many-body} = \frac{1}{2} \sum_{i=0}^{N_\mathrm{particles}-1}
\sum_{j \ne i}
\sum_{j \ne k} U(\vec{r}_{ij}, \vec{r}_{ik})

Expand Down
2 changes: 1 addition & 1 deletion hoomd/md/pair/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

.. math::

U_\mathrm{pair,total} = \frac{1}{2} \sum_{i=0}^\mathrm{N_particles-1}
U_\mathrm{pair,total} = \frac{1}{2} \sum_{i=0}^{N_\mathrm{particles}-1}
\sum_{j \ne i, (i,j) \notin \mathrm{exclusions}}
U_\mathrm{pair}(r_{ij})

Expand Down
2 changes: 1 addition & 1 deletion hoomd/md/pair/aniso.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

.. math::

U_\mathrm{pair,total} = \frac{1}{2} \sum_{i=0}^\mathrm{N_particles-1}
U_\mathrm{pair,total} = \frac{1}{2} \sum_{i=0}^{N_\mathrm{particles}-1}
\sum_{j \ne i, (i,j) \notin \mathrm{exclusions}}
U_\mathrm{pair}(r_{ij}, \mathbf{q}_i, \mathbf{q}_j)

Expand Down