zhyang-dev/LPP
1
0
Fork 0
mirror of https://github.com/ParticulateFlow/LPP.git synced 2025-12-08 06:37:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

added documentation for --no-overwrite flag

Browse Source
This commit is contained in:
Stefan A
2012-04-13 15:22:23 +02:00
parent c9fa9ccc67
commit 029a1a243d
4 changed files with 22 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/Manual.html
View File

@ -143,6 +143,7 @@ so we can improve the Pizza.py documentation.
<TR><TD ><A HREF = "image.html">image.py</A></TD><TD > View and manipulate images</TD></TR>
<TR><TD ><A HREF = "ldump.html">ldump.py</A></TD><TD > Read LAMMPS dump files with line info</TD></TR>
<TR><TD ><A HREF = "log.html">log.py</A></TD><TD > Read LAMMPS log files and extract thermodynamic data</TD></TR>
<TR><TD ><A HREF = "lpp.html">lpp.py</A></TD><TD > LIGGGHTS parallel postprocessing</TD></TR>
<TR><TD ><A HREF = "matlab.html">matlab.py</A></TD><TD > Create plots via <A HREF = "http://www.mathworks.com">MatLab</A> numerical analysis program</TD></TR>
<TR><TD ><A HREF = "mdump.html">mdump.py</A></TD><TD > Read, write, manipulate mesh dump files</TD></TR>
<TR><TD ><A HREF = "pair.html">pair.py</A></TD><TD > Compute LAMMPS pairwise energies</TD></TR>

1
doc/Manual.txt
View File

@ -114,6 +114,7 @@ List of tools in Pizza.py:
"image.py"_image.html; View and manipulate images
"ldump.py"_ldump.html; Read LAMMPS dump files with line info
"log.py"_log.html; Read LAMMPS log files and extract thermodynamic data
"lpp.py"_lpp.html; LIGGGHTS parallel postprocessing
"matlab.py"_matlab.html; Create plots via "MatLab"_matlab numerical analysis program
"mdump.py"_mdump.html; Read, write, manipulate mesh dump files
"pair.py"_pair.html; Compute LAMMPS pairwise energies

17
doc/lpp.html
View File

@ -108,17 +108,20 @@ button and then in the object inspector:
</P>
<P>A few command line options are avaliable to control lpp:
</P>
<P>-o fname : define output file names (default is liggghts + timestep number). This option can also be used to write to a specified folder, eg. "lpp -o foo/bar dump*" will create files bar1000.vtk, bar2000.vtk etc. in the directory ./foo while "lpp -o foo/ dump*" will create files named liggghts1000.vtk, ligggghts2000.vtk etc. in ./foo (providing the directory exists, lpp will not create any directories for you!)
<P><B>-o fname</B> : define output file names (default is liggghts + timestep number). This option can also be used to write to a specified folder, eg. "lpp -o foo/bar dump*" will create files bar1000.vtk, bar2000.vtk etc. in the directory ./foo while "lpp -o foo/ dump*" will create files named liggghts1000.vtk, ligggghts2000.vtk etc. in ./foo (providing the directory exists, lpp will not create any directories for you!)
</P>
<P>--chunksize : sets the amount of dumpfiles processed per chunk, the default is 8. Increasing the chunksize can improve performance, but the chunksize is limited by the amount of RAM on your system. Also keep in mind that multiple chunks may be processed depending on your --cpunum settings, and thus RAM demand is multiplied.
<P><B>--chunksize</B> : sets the amount of dumpfiles processed per chunk, the default is 8. Increasing the chunksize can improve performance, but the chunksize is limited by the amount of RAM on your system. Also keep in mind that multiple chunks may be processed depending on your --cpunum settings, and thus RAM demand is multiplied.
</P>
<P>--cpunum : sets the number of processes to start, default (and maximum) is the amount of cpu cores avaliable at your system.
<P><B>--cpunum</B> : sets the number of processes to start, default (and maximum) is the amount of cpu cores avaliable at your system.
</P>
<P>--debug : prints debug information, usually not needed
<P><B>--debug</B> : prints debug information, usually not needed
</P>
<P>--quiet : suppresses all output but error messages (also discards --debug)
<P><B>--help</B> : writes a help message and exits
</P>
<P>--help : writes a help message and exits
<P><B>--no-overwrite</B> : if set lpp does not process dump-files that have already been
converted, i.e. where the vtk-file already exists.
</P>
<P><B>--quiet</B> : suppresses all output but error messages (also discards --debug)
</P>
<HR>
@ -130,6 +133,6 @@ button and then in the object inspector:
<P><B>Prerequisites:</B>
</P>
<P>Python "multiprocessing" tool
<P>Python <A HREF = "http://docs.python.org/library/multiprocessing.html">multiprocessing library</A> (new in python 2.6)
</P>
</HTML>

17
doc/lpp.txt
View File

@ -94,17 +94,20 @@ In a similar fashion, you can set up vector glyphs to visualize velocity etc.
A few command line options are avaliable to control lpp:
-o fname : define output file names (default is liggghts + timestep number). This option can also be used to write to a specified folder, eg. "lpp -o foo/bar dump*" will create files bar1000.vtk, bar2000.vtk etc. in the directory ./foo while "lpp -o foo/ dump*" will create files named liggghts1000.vtk, ligggghts2000.vtk etc. in ./foo (providing the directory exists, lpp will not create any directories for you!)
[-o fname] : define output file names (default is liggghts + timestep number). This option can also be used to write to a specified folder, eg. "lpp -o foo/bar dump*" will create files bar1000.vtk, bar2000.vtk etc. in the directory ./foo while "lpp -o foo/ dump*" will create files named liggghts1000.vtk, ligggghts2000.vtk etc. in ./foo (providing the directory exists, lpp will not create any directories for you!)
--chunksize : sets the amount of dumpfiles processed per chunk, the default is 8. Increasing the chunksize can improve performance, but the chunksize is limited by the amount of RAM on your system. Also keep in mind that multiple chunks may be processed depending on your --cpunum settings, and thus RAM demand is multiplied.
[--chunksize] : sets the amount of dumpfiles processed per chunk, the default is 8. Increasing the chunksize can improve performance, but the chunksize is limited by the amount of RAM on your system. Also keep in mind that multiple chunks may be processed depending on your --cpunum settings, and thus RAM demand is multiplied.
--cpunum : sets the number of processes to start, default (and maximum) is the amount of cpu cores avaliable at your system.
[--cpunum] : sets the number of processes to start, default (and maximum) is the amount of cpu cores avaliable at your system.
--debug : prints debug information, usually not needed
[--debug] : prints debug information, usually not needed
--quiet : suppresses all output but error messages (also discards --debug)
[--help] : writes a help message and exits
--help : writes a help message and exits
[--no-overwrite] : if set lpp does not process dump-files that have already been
converted, i.e. where the vtk-file already exists.
[--quiet] : suppresses all output but error messages (also discards --debug)
:line
@ -116,4 +119,4 @@ A few command line options are avaliable to control lpp:
[Prerequisites:]
Python "multiprocessing" tool
Python "multiprocessing library"_http://docs.python.org/library/multiprocessing.html (new in python 2.6)