Merge pull request #1768 from ellio167/doc-conda

Add Install_conda doc
This commit is contained in:
Axel Kohlmeyer
2019-11-11 17:11:22 -05:00
committed by GitHub
6 changed files with 65 additions and 112 deletions

View File

@ -15,6 +15,7 @@ need the source code.
Install_linux
Install_mac
Install_windows
Install_conda
Install_tarball
Install_git

53
doc/src/Install_conda.rst Normal file
View File

@ -0,0 +1,53 @@
Download an executable for Linux or Mac via Conda
=================================================
Binaries are available for macOS or Linux via `Conda <conda_>`_.
First, one must setup the Conda package manager on your system. Follow the
instructions to install `Miniconda <mini_conda_install_>`_, then create a conda
environment (named `my-lammps-env` or whatever you prefer) for your lammps
install:
.. parsed-literal::
% conda config --add channels conda-forge
% conda create -n my-lammps-env
Then, you can install lammps on your system with the following command:
.. parsed-literal::
% conda activate my-lammps-env
% conda install lammps
The LAMMPS binary is built with the :ref:`KIM package <kim>` which
results in Conda also installing the `kim-api` binaries when LAMMPS is
installed. In order to use potentials from `openkim.org <openkim_>`_, you can
install the `openkim-models` package
.. parsed-literal::
% conda install openkim-models
If you have problems with the installation you can post issues to
`this link <conda_forge_lammps_>`_.
.. _conda_forge_lammps: https://github.com/conda-forge/lammps-feedstock/issues
Thanks to Jan Janssen (Max-Planck-Institut für Eisenforschung) for setting
up the Conda capability.
.. _openkim: https://openkim.org
.. _conda: https://docs.conda.io/en/latest/index.html
.. _mini_conda_install: https://docs.conda.io/en/latest/miniconda.html
.. _lws: http://lammps.sandia.gov
.. _ld: Manual.html
.. _lc: Commands_all.html

View File

@ -2,9 +2,10 @@ Download an executable for Mac
==============================
LAMMPS can be downloaded, built, and configured for OS X on a Mac with
`Homebrew <homebrew_>`_. The following LAMMPS packages are unavailable at this
time because of additional needs not yet met: GPU, KOKKOS, LATTE, MSCG,
MESSAGE, MPIIO POEMS VORONOI.
`Homebrew <homebrew_>`_. (Alternatively, see the install instructions for
:doc:`Download an executable via Conda <Install_conda>`.) The following LAMMPS
packages are unavailable at this time because of additional needs not yet met:
GPU, KOKKOS, LATTE, MSCG, MESSAGE, MPIIO POEMS VORONOI.
After installing Homebrew, you can install LAMMPS on your system with
the following commands:
@ -48,7 +49,6 @@ up the Homebrew capability.
.. _lws: http://lammps.sandia.gov
.. _ld: Manual.html
.. _lc: Commands_all.html