quick_vis package

Submodules

quick_vis.slice_plot module

usage: slice_plot [-h] [--datapath DATAPATH] [--outpath OUTPATH]
                  [--pname PNAME [PNAME ...]] [--field FIELD] [--SI]
                  [--verbose] [--no_mpi] [--nprocs NPROCS] [--nskip NSKIP]
                  [--ifile IFILE] [--normal NORMAL]
                  [--grid_offset GRID_OFFSET] [--cmap CMAP] [--dpi DPI]
                  [--pbox PBOX [PBOX ...]] [--fbounds FBOUNDS [FBOUNDS ...]]
                  [--center CENTER [CENTER ...]] [--plot_log]
                  [--grids GRIDS [GRIDS ...]] [--cells CELLS [CELLS ...]]
                  [--buff BUFF [BUFF ...]] [--contour CONTOUR [CONTOUR ...]]
                  [--clw CLW [CLW ...]] [--pickle]
                  [--grid_info GRID_INFO [GRID_INFO ...]] [--rm_eb RM_EB]
                  [--gradient {x,y,z,magnitude}] [--no_time] [--no_units]
                  [--add_udf ADD_UDF] [--use_tex]

Named Arguments

--datapath

Path to the data files.

--outpath

Path to the output directory.

--pname

Name of plt files to plot (if empty, do all)

--field

Name of the field for visualization.

--SI

Flag to set the units to SI (default is cgs).

Default: False

--verbose

Flag to turn on various statements.

Default: False

--no_mpi

Flag to manually disable mpi features.

Default: False

--nprocs

Number of processors to devote to each file when operating inparallel mode

Default: 1

--nskip

Skip every “nskip” entries in “pname” list.

--ifile

Path to the input file for configuring plots.

--normal

Normal direction for the slice plot.

Default: “z”

--grid_offset

Amount to offset center to avoid grid alignment vis issues.

Default: 0.0

--cmap

Colormap for the 2D plot.

Default: “dusk”

--dpi

dpi of the output image (default = 300).

Default: 300

--pbox

Bounding box of the plot specified by the two corners (x0 y0 x1 y1).

--fbounds

Bounds for the colorbar.

--center

Coordinate list for center of slice plot (x, y, z).

--plot_log

Plot in log values.

Default: False

--grids

Options to specify annotate grids (alpha, min_level, max_level, linewidth).

--cells

Options to specify annotate cells (linewidth, alpha, color).

--buff

Buffer for the SlicePlot image for plotting.

--contour

Name of contour field and value to plot on top of slice.

--clw

Linewidth for each of the contour lines.

--pickle

Flag to store image as pickle for later manipulation.

Default: False

--grid_info

Add text box with grid information (xloc, yloc, min_lev, max_lev).

--rm_eb

Float value to plot non-fluid using binary cmap [0, 1].

--gradient

Possible choices: x, y, z, magnitude

Choice to visualize the gradient of the input field.

--no_time

Flag to remove the timestamp.

Default: False

--no_units

Flag to remove all units from plots.

Default: False

--add_udf

Name of user defined functions file (located in udfs/).

--use_tex

Flag to use latex parser.

Default: False

2D slice down the middle of the domain.

quick_vis.slice_plot.get_args(parser)

Get the arguments from the parser.

quick_vis.slice_plot.get_base_parser()

Get the base level parser primarily for documentation.

quick_vis.slice_plot.get_parser()

Get the parser.

quick_vis.slice_plot.main()

quick_vis.slice_plot.plot_contours(contour, ax, left_edge, dxy, color, linewidth)

Add contours to plot axes.

Module contents

class quick_vis.ListScriptsAction(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

Bases: Action

quick_vis.list_scripts(directory)

quick_vis.main()