Merge pull request #2101 from glotzerlab/fix-sdf-documentation

Fix documentation errors

Author: joaander

CHANGELOG.rst

@@ -17,6 +17,8 @@ Change Log
   (`#2091 <https://github.com/glotzerlab/hoomd-blue/pull/2091>`__).
 * Reduce the time needed to generate mesh bonds
   (`#2097 <https://github.com/glotzerlab/hoomd-blue/pull/2097>`__).
+* Equations displayed in ``hoomd.hpmc.compute.SDF`` documentation
+  (`#2096 <https://github.com/glotzerlab/hoomd-blue/discussions/2096>`__).
 
 5.3.0 (2025-06-26)
 ^^^^^^^^^^^^^^^^^^

hoomd/hpmc/compute.py

@@ -441,8 +441,8 @@ def betaP(self):  # noqa: N802 - allow function name
         required) and computes the pressure via:
 
         .. math::
-            \\beta P = \\rho \\left(1 + \\frac{s_\\mathrm{comp}(0+)}{2d} +
-            \\frac{s_\\mathrm{exp}(0-)}{2d} \
+            \\beta P = \\rho \\left(1 +
+            \\frac{s_\\mathrm{comp}(0+) - s_\\mathrm{exp}(0-)}{2d} \
             \\right)
 
         where :math:`d` is the dimensionality of the system, :math:`\\rho` is

hoomd/hpmc/pair/step.py

@@ -42,7 +42,7 @@ class Step(Pair):
 
     .. code-block:: python
 
-        step =  hoomd.hpmc.pair.Step()
+        step = hoomd.hpmc.pair.Step()
         step.params[('A', 'A')] = dict(epsilon=[1, -1], r=[0.5, 1.5])
         simulation.operations.integrator.pair_potentials = [step]
 

hoomd/hpmc/pair/zetterling.py

@@ -70,7 +70,7 @@ class Zetterling(Pair):
           Energy scale of the first term :math:`A`
           :math:`[\\mathrm{energy}]`
         * ``alpha`` (`float`, **required**) -
-          Screening factor :math:`\alpha`
+          Screening factor :math:`\\alpha`
           :math:`[\\mathrm{length}^{-1}]`
         * ``kf`` (`float`, **required**) -
           Wave number to mimic the Friedel oscillations effect :math:`k_F`