This analysis script interrogates particles data files, and writes them in a text file format suitable for use in the fileDensSrc kind of species source, or for those who want to have ascii format data to read into another code.
-s <simname>, --simulationName=<simname>(string, required)
<simname> is the name of the simulation to be analyzed. The file extension should NOT be included in this text field.
-S <spname>, --speciesName=<spname>(string, required)
<spname> is the name of the species which is the source of the export operation.
-d <num>, --dumpNum=<num>(int, required)
Which dump number to export.
-O <outname>, --outputFileName=<outname>(string, optional)
<outname> is the name of the output file, including extension. Not used if numOutFiles > 1.
-o <outbasename>, --outputBaseName=<outbasename>(string, optional)
Name of the output file, no extension, compatible with the fileDensSrc applyPeriod parameter. Only used if numOutFiles > 1.
-N <files>, --numOutFiles=<files>(int, required, default = 1)
Will convert the H5 file to this many .dat files, each containing totalNumPtcls/numOutFiles. Useful for loading the electrons over a period of time.
-P, --applyPeriod(int, optional)
If using the fileDensSrc applyPeriod parameter, set this equal to your applyPeriod.
-R, --randomizePtcls(int, required, default = 1)
0 or 1. If 1, will copy particles in random order.
-w, --overwrite(flag)
Whether a dataset or group should be overwritten if it already exists.
This analysis script outputs one or more ascii files readable in any test editor, potentially with a filtered set of particles ready for re-import.
If you are running this analyzer from the UI, and the output dataset file already exists, then it will be overwritten each time the analyzer is run, unless you uncheck the Overwrite Existing Files box near the bottom of the Analysis Results pane.
If you are running the analyzer from the command line, the dataset will not be overwritten
unless the -w, or --overwrite flag is specified on the command line.
The results of your analyzer may not be written into the output file if you have not specified the overwrite option to be True.