diff --git a/doc/src/Build_settings.rst b/doc/src/Build_settings.rst index b6aa6e4114..cefadc183e 100644 --- a/doc/src/Build_settings.rst +++ b/doc/src/Build_settings.rst @@ -8,7 +8,8 @@ explains how to do this for building both with CMake and make. * `FFT library`_ for use with the :doc:`kspace_style pppm ` command * `Size of LAMMPS integer types and size limits`_ * `Read or write compressed files`_ -* `Output of JPG, PNG, and move files` via the :doc:`dump image ` or :doc:`dump movie ` commands +* `Output of JPEG, PNG, and movie files`_ via the :doc:`dump image ` or :doc:`dump movie ` commands +* `Support for downloading files`_ * `Memory allocation alignment`_ * `Workaround for long long integers`_ * `Exception handling when using LAMMPS as a library`_ to capture errors @@ -19,7 +20,7 @@ explains how to do this for building both with CMake and make. .. _cxx11: C++11 standard compliance ------------------------------------------- +------------------------- A C++11 standard compatible compiler is a requirement for compiling LAMMPS. LAMMPS version 3 March 2020 is the last version compatible with the previous @@ -31,12 +32,16 @@ flags to enable C++11 compliance. Example for GNU c++ 4.8.x: CCFLAGS = -g -O3 -std=c++11 +Individual packages may require compliance with a later C++ standard +like C++14 or C++17. These requirements will be documented with the +:doc:`individual packages `. + ---------- .. _fft: FFT library ---------------------- +----------- When the KSPACE package is included in a LAMMPS build, the :doc:`kspace_style pppm ` command performs 3d FFTs which @@ -341,8 +346,8 @@ in whichever ``lib/gpu/Makefile`` is used must be the same as above. .. _graphics: -Output of JPG, PNG, and movie files --------------------------------------------------- +Output of JPEG, PNG, and movie files +------------------------------------ The :doc:`dump image ` command has options to output JPEG or PNG image files. Likewise, the :doc:`dump movie ` command @@ -356,9 +361,9 @@ requires the following settings: .. code-block:: bash -D WITH_JPEG=value # yes or no - # default = yes if CMake finds JPEG files, else no + # default = yes if CMake finds JPEG development files, else no -D WITH_PNG=value # yes or no - # default = yes if CMake finds PNG and ZLIB files, else no + # default = yes if CMake finds PNG and ZLIB development files, else no -D WITH_FFMPEG=value # yes or no # default = yes if CMake can find ffmpeg, else no @@ -446,12 +451,56 @@ during a run. available using a compression library instead, which is what the :ref:`COMPRESS package ` enables. +-------------------------------------------------- + +.. _libcurl: + +Support for downloading files +----------------------------- + +The :doc:`geturl command ` command uses the `the libcurl library +`_ to download files. This requires that +LAMMPS is compiled accordingly which needs the following settings: + +.. tabs:: + + .. tab:: CMake build + + .. code-block:: bash + + -D WITH_CURL=value # yes or no + # default = yes if CMake finds CURL development files, else no + + Usually these settings are all that is needed. If CMake cannot + find the graphics header, library, executable files, you can set + these variables: + + .. code-block:: bash + + -D CURL_INCLUDE_DIR=path # path to folder which contains curl.h header file + -D CURL_LIBRARY=path # path to libcurls.a (.so) file + + .. tab:: Traditional make + + .. code-block:: make + + LMP_INC = -DLAMMPS_CURL + + CURL_INC = -I/usr/local/include # path to curl folder with curl.h + CURL_PATH = -L/usr/lib # paths to libcurl.a(.so) if make cannot find it + CURL_LIB = -lcurl # library names + + As with CMake, you do not need to set ``CURL_INC`` or ``CURL_PATH``, + if make can find the libcurl header and library files in their + default system locations. You must specify ``CURL_LIB`` with a + paths or linker flags to link to libcurl. + ---------- .. _align: Memory allocation alignment ---------------------------------------- +--------------------------- This setting enables the use of the "posix_memalign()" call instead of "malloc()" when LAMMPS allocates large chunks of memory. Vector diff --git a/doc/src/Commands_all.rst b/doc/src/Commands_all.rst index 4a035f5b41..cb31369501 100644 --- a/doc/src/Commands_all.rst +++ b/doc/src/Commands_all.rst @@ -54,6 +54,7 @@ table above. * :doc:`echo ` * :doc:`fix ` * :doc:`fix_modify ` + * :doc:`geturl ` * :doc:`group ` * :doc:`if ` * :doc:`improper_coeff ` diff --git a/doc/src/commands_list.rst b/doc/src/commands_list.rst index cea237f14e..b297b6dbf5 100644 --- a/doc/src/commands_list.rst +++ b/doc/src/commands_list.rst @@ -45,6 +45,7 @@ Commands fix fix_modify fitpod_command + geturl group group2ndx hyper diff --git a/doc/utils/sphinx-config/false_positives.txt b/doc/utils/sphinx-config/false_positives.txt index 5406c3ac79..f6db58ecd9 100644 --- a/doc/utils/sphinx-config/false_positives.txt +++ b/doc/utils/sphinx-config/false_positives.txt @@ -1298,6 +1298,7 @@ Gershgorin getrusage getter gettimeofday +geturl gewald Gezelter Gflop @@ -1492,6 +1493,8 @@ hplanck Hs hstyle html +http +https hTST https hu @@ -3349,6 +3352,7 @@ Schunk Schuring Schwen Sci +scp screenshot screenshots Scripps @@ -3389,6 +3393,7 @@ setvel sevenbody sfftw sfree +sftp Sg sgcmc Shan @@ -3903,6 +3908,7 @@ upenn upto Urbakh Urbana +url UreyBradley Usabiaga usec