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

another tweak

Browse Source
This commit is contained in:
Steve Plimpton
2025-06-09 16:50:43 -06:00
parent 7a7ec8083f
commit 1f57be8255
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/src/python.rst
View File

@ -187,18 +187,18 @@ is allowed since their operations are mutually exclusive.
If the *invoke* keyword is used, no other keywords can be used. A If the *invoke* keyword is used, no other keywords can be used. A
previous *python* command must have registered the Python function previous *python* command must have registered the Python function
referenced by this command. The *invoke* keyword invokes the Python referenced by this command, which can then be invoked multiple times
function with the previously defined arguments. A return value of the in an input script via the *invoke* keyword. Each invocation passes
Python function will be ignored unless the Python function is linked current values for arguments to the Python function. A return value
to a :doc:`python style variable <variable>` with the *return* of the Python function will be ignored unless the Python function is
linked to a :doc:`python style variable <variable>` with the *return*
keyword. This return value can be logged to the screen and logfile by keyword. This return value can be logged to the screen and logfile by
adding the optional *logreturn* argument to the *invoke* keyword. In adding the optional *logreturn* argument to the *invoke* keyword. In
that case a message with the name of the python command and the return that case a message with the name of the python command and the return
value is printed. Note that return values of python functions are value is printed. Note that return values of python functions are
otherwise *only* accessible when the function is invoked indirectly by otherwise *only* accessible when the function is invoked indirectly by
expanding a :doc:`python style variable <variable>`, as described expanding a :doc:`python style variable <variable>`, as described
below. A registered function can be invoked as many times as you wish below.
in your input script.
The *file* keyword gives the name of a file containing Python code, The *file* keyword gives the name of a file containing Python code,
which should end with a ".py" suffix. The code will be immediately which should end with a ".py" suffix. The code will be immediately