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.

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

Jump to bottom

Documentation fixes #1585

Merged
merged 3 commits into from
Jul 13, 2023
Merged

Documentation fixes #1585

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7ed210
Recommend installing CUDA 12.0 builds from conda-forge.
joaander Jul 13, 2023
a331378
Fix typo in net_virial documentation.
joaander Jul 13, 2023
41695b4
Note how to install CUDA 11 HOOMD from conda forge.
joaander Jul 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 7 additions & 2 deletions INSTALLING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,18 @@ Install the ``hoomd`` package from the conda-forge_ channel into a conda environ
``conda`` auto-detects whether your system has a GPU and attempts to install the appropriate
package. Override this and force the GPU enabled package installation with::

$ export CONDA_OVERRIDE_CUDA="11.2"
$ conda install "hoomd=4.0.1=*gpu*"
$ export CONDA_OVERRIDE_CUDA="12.0"
$ conda install "hoomd=4.0.1=*gpu*" "cuda-version=12.0"

Similarly, you can force CPU only package installation with::

$ conda install "hoomd=4.0.1=*cpu*"

.. note::

CUDA 11.2 compatible packages are also available. Replace "12.0" with "11.2" above when
installing HOOMD-blue on systems with CUDA 11 compatible drivers.

.. note::

To use :ref:`run time compilation` on **macOS**, install the ``compilers`` package::
Expand Down
2 changes: 1 addition & 1 deletion hoomd/data/local_access.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ class ParticleLocalAccessBase(_LocalAccess):
net_torque ((N_particles, 3) `hoomd.data.array` object of ``float``):
Net torque on particle
:math:`[\\mathrm{force} \\cdot \\mathrm{length}]`.
net_virial ((N_particles, 3) `hoomd.data.array` object of ``float``):
net_virial ((N_particles, 6) `hoomd.data.array` object of ``float``):
Net virial on particle :math:`[\\mathrm{energy}]`.
net_energy ((N_particles,) `hoomd.data.array` object of ``float``):
Net energy of a particle :math:`[\\mathrm{energy}]`.
Expand Down