ytscripts package

Submodules

ytscripts.utilities module

Utility routines used throughout ytscripts.

ytscripts.utilities.compute_elem_mass_fraction(attributes, keys=None)

Compute the elem mass fraction for streams.

ytscripts.utilities.create_index_dict(all_files, plt_files)

Create a dictionary of the index of the plot files.

ytscripts.utilities.define_velocity_fields(ds)

Add some velocity fields.

ytscripts.utilities.get_attributes(ds)

Gets commonly used attributes from the dataset and stores in dict.

ytscripts.utilities.get_configs()

Parse the configuration options from toml file.

ytscripts.utilities.get_fig_aspect_ratio(xlen, ylen, base=5)

Get the aspect ratio to fit the data.

ytscripts.utilities.get_files(datapath, pattern='plt*')

Get all the plt files in the directory.

ytscripts.utilities.get_gradient_field(ds, field, grad_type)

Add the gradient field and return new field name.

ytscripts.utilities.is_latex_available()

Check if latex is available.

ytscripts.utilities.is_notebook()

Check if the script is running in a Jupyter notebook.

ytscripts.utilities.load_dataseries(datapath, pname=None, units_override=None, nprocs=1, nskip=None)

Load a series of datasets from files in a given directory.

Parameters: - datapath (str): The path to the directory containing the dataset files. - pname (list, optional): A list of patterns to match the dataset files. - units_override (dict, optional): A dictionary specifying unit overrides for the loaded datasets. Default is None. - nprocs (int, optional): The number of processes to use for parallel loading. - nskip (int, optional): The number of files to skip between loaded datasets.

Returns: - ts (yt.DatasetSeries): A series of loaded datasets. - index_dict (dict): A dictionary mapping file indices to their corresponding dataset indices.

ytscripts.ytargs module

Argument Parser classes for common arguments.

class ytscripts.ytargs.ytAnalysisArgs(**kwargs)

Bases: ytArgs

Class to interface with custom data analysis functions.

mixture_fraction()

Add in arguments for analyzing mixture fraction data.

class ytscripts.ytargs.ytArgs

Bases: object

Base class with standard inputs for yt scripts.

add_args_from_dict(args)

Add arguments from a dictionary.

add_mutually_exclusive_args_from_dict(args)

Add mutually exclusive arguments from a dictionary.

get_parser()

Return the parser.

io_args()

Add I/O arguments.

orientation_args()

Add 2D slicing arguments.

override_args(init_args, input_file)

Override CLI arguments with those from input file.

parse_args(args=None)

Return the parsed args.

remove_arg(arg)

Remove argument from parser.

vis_2d_args()

Add 2D visualization arguments.

class ytscripts.ytargs.ytExtractArgs(**kwargs)

Bases: ytArgs

Class to interface with custom data extraction functions.

average_args()

Add arguments for extracting averages.

grid_args()

Add arguments for extracting grid info.

isosurface_args()

Add arguments for extracting iso-surfaces.

slice_args()

Add arguments for extract slices routine.

class ytscripts.ytargs.ytPlotArgs(**kwargs)

Bases: ytArgs

Class to interface with custom plot functions.

average_args()

Add arguments for plotting averages.

grid_args()

Add arguments for plotting grid info.

slice_args()

Add arguments for plotting slices.

class ytscripts.ytargs.ytVisArgs(**kwargs)

Bases: ytArgs

Class to interface with standard yt visualization functions.

slice_args()

Add arguments for SlicePlot.

Module contents