ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Tweaked build instructions

Browse Source
This commit is contained in:
Aidan Thompson
2020-12-09 17:12:35 -07:00
parent 56feb03b38
commit 4964a56974
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/src/Build_extras.rst
View File

@ -741,7 +741,7 @@ MLIAP package
Building the MLIAP package requires including the :ref:`SNAP <PKG-SNAP>`
package. There will be an error message if this requirement is not satisfied.
Using the *mliappy* model also requires enabling the :ref:`PYTHON <PKG-PYTHON>`
package **and** requires you have the `cython <https://ctyhon.org>`_ software
package **and** requires you have the `cython <https://cython.org>`_ software
installed and with it a working ``cythonize`` command. This feature requires
compiling LAMMPS with Python version 3.6 or later.
@ -765,16 +765,17 @@ compiling LAMMPS with Python version 3.6 or later.
The build uses the ``lib/python/Makefile.mliap_python`` file in the
compile/link process to add a rule to update the files generated by
the ``cythonize`` command in case the corresponding .pyx file was
modified. You may need to need to modify ``lib/python/Makefile.lammps``
the ``cythonize`` command in case the corresponding .pyx file(s) were
modified. You may need to modify ``lib/python/Makefile.lammps``
if the LAMMPS build fails.
To manually enforce building MLIAP with Python support, you can add
To manually enforce building MLIAP with Python support enabled,
you can add
``-DMLIAP_PYTHON`` to the ``LMP_INC`` variable in your machine makefile.
You may have to manually run the cythonize command on .pyx file(s)
in the ``src`` folder, if this is not automatically done during
installing the MLIAP package. Please do **not** run ``cythonize``
in the ``src/MLIAP`` folder, as that can lead to compilation errors
if PYTHON support is not included.
if Python support is not enabled.
If you did by accident, please remove the generated .cpp and .h files.
----------