Command Line Interface¶

usage: packcubes [-h] [-v] [-n N] [-p PARTICLE_THRESHOLD] [-x X] [-dx DX]
                                                   [-y Y] [-dy DY] [-z Z] [-dz DZ] [-c CONFIG]
                                                   [-t PARTICLE_TYPES [PARTICLE_TYPES ...]]
                                                   [--force-overwrite] [--no-saving-dataset]
                                                   snapshot [output]

Run the packingcubes program on a snapshot file. Default is to use the bounding box provided by the
simulation, so if that's sufficient you do not need to provide x/y/z/dx/dy/dz

positional arguments:
  snapshot              Path to the snapshot file
  output                Name of hdf5 file to save cubes information to. If not specified, cubes information
                        will be discarded!

options:
  -h, --help            show this help message and exit
  -v, --verbose         increase output verbosity
  -n, --side-length N   number of cells per side [3-32], default -1 means use the lowest number of cells such
                        that n**3 > # of available threads
  -p, --particle-threshold PARTICLE_THRESHOLD
                        the maximum number of particles per octree leaf. Default: 400
  -c, --config CONFIG   Read in specified config file for arguments (CLI arguments will override)
  -t, --particle-types PARTICLE_TYPES [PARTICLE_TYPES ...]
                        Names of particles to include (Can be integers or strings, 0 <=> PartType0)
  --force-overwrite     Flag to overwrite cubes data contained in OUTPUT
  --no-saving-dataset   Don't save sorted particle positions and shuffle lists Normally sorted particle
                        positions/shuffle lists are saved within a sidecar file to the snapshot. This flag
                        disables that behavior.

Box parameters:
  Arguments to override parts of the default bounding box

  -x X                  minimum bounding box x coordinate
  -dx DX                bounding box size in x direction
  -y Y                  minimum bounding box y coordinate
  -dy DY                bounding box size in y direction
  -z Z                  minimum bounding box z coordinate
  -dz DZ                bounding box size in z direction

If particle types are specified (using -t or --particle-types), the snapshot file should be specified with --
SNAPSHOT OUTPUT at the end. Additional arguments can be read from a file by specifying the file with
`@filename` anywhere among the argument string. Any arguments found in the file will overwrite previously
specified arguments and be overwritten by arguments specified later. Note that this is different behavior
from the -c/--config argument!