From 029a1a243d962d20c5e97e09fc73ddbd27cb021c Mon Sep 17 00:00:00 2001 From: Stefan A Date: Fri, 13 Apr 2012 15:22:23 +0200 Subject: [PATCH] added documentation for --no-overwrite flag --- doc/Manual.html | 1 + doc/Manual.txt | 1 + doc/lpp.html | 17 ++++++++++------- doc/lpp.txt | 17 ++++++++++------- 4 files changed, 22 insertions(+), 14 deletions(-) diff --git a/doc/Manual.html b/doc/Manual.html index 9910981..85cd0a8 100644 --- a/doc/Manual.html +++ b/doc/Manual.html @@ -143,6 +143,7 @@ so we can improve the Pizza.py documentation. image.py View and manipulate images ldump.py Read LAMMPS dump files with line info log.py Read LAMMPS log files and extract thermodynamic data +lpp.py LIGGGHTS parallel postprocessing matlab.py Create plots via MatLab numerical analysis program mdump.py Read, write, manipulate mesh dump files pair.py Compute LAMMPS pairwise energies diff --git a/doc/Manual.txt b/doc/Manual.txt index f24d4b1..2829829 100644 --- a/doc/Manual.txt +++ b/doc/Manual.txt @@ -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 diff --git a/doc/lpp.html b/doc/lpp.html index be3e841..2e33c26 100644 --- a/doc/lpp.html +++ b/doc/lpp.html @@ -108,17 +108,20 @@ button and then in the object inspector:

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)

@@ -130,6 +133,6 @@ button and then in the object inspector:

Prerequisites:

-

Python "multiprocessing" tool +

Python multiprocessing library (new in python 2.6)

diff --git a/doc/lpp.txt b/doc/lpp.txt index c877a74..0238337 100644 --- a/doc/lpp.txt +++ b/doc/lpp.txt @@ -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)