Skip to content

Commit

Permalink
doc: link to GPU usage docs from lammps install section
Browse files Browse the repository at this point in the history
  • Loading branch information
elcorto committed Jun 20, 2024
1 parent d59a57f commit c4c587f
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
3 changes: 2 additions & 1 deletion docs/source/advanced_usage/predictions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Likewise, you can adjust the inference temperature via
calculator.data_handler.target_calculator.temperature = ...
.. _production_gpu:

Predictions on GPU
*******************

Expand Down Expand Up @@ -137,4 +139,3 @@ With the exception of the electronic density, which is saved into the ``.cube``
format for visualization with regular electronic structure visualization
software, all of these observables can be plotted with Python based
visualization libraries such as ``matplotlib``.

10 changes: 8 additions & 2 deletions docs/source/install/installing_lammps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,18 +41,24 @@ The MALA team recommends to build LAMMPS with ``cmake``. To do so
* ``Kokkos_ARCH_GPUARCH=???``: Your GPU architecture (see see `Kokkos instructions <https://docs.lammps.org/Build_extras.html#kokkos-package>`_)
* ``CMAKE_CXX_COMPILER=???``: Path to the ``nvcc_wrapper`` executable
shipped with the LAMMPS code, should be at ``/your/path/to/lammps/lib/kokkos/bin/nvcc_wrapper``
* For example, this configures the LAMMPS cmake build with Kokkos support
for an Intel Haswell CPU and an Nvidia Volta GPU, with MPI support:

For example, this configures the LAMMPS cmake build with Kokkos support
for an Intel Haswell CPU and an Nvidia Volta GPU, with MPI support:

.. code-block:: bash
cmake ../cmake -D PKG_KOKKOS=yes -D BUILD_MPI=yes -D PKG_ML-SNAP=yes -D Kokkos_ENABLE_CUDA=yes -D Kokkos_ARCH_HSW=yes -D Kokkos_ARCH_VOLTA70=yes -D CMAKE_CXX_COMPILER=/path/to/lammps/lib/kokkos/bin/nvcc_wrapper -D BUILD_SHARED_LIBS=yes
.. note::
When using a GPU by setting ``parameters.use_gpu = True``, you *need* to
have a GPU version of ``LAMMPS`` installed. See :ref:`production_gpu` for
details.

* Build the library and executable with ``cmake --build .``
(Add ``--parallel=8`` for a faster build)



Installing the Python extension
********************************

Expand Down

0 comments on commit c4c587f

Please sign in to comment.