API Reference

ThunderBoltz([directory, cs, out_file, ...])

ThunderBoltz 0D DSMC simulation wrapper.

Build from Files

tb.read(directory[, read_cs_data])

Create a ThunderBoltz object by reading from a ThunderBoltz simulation directory.

tb.query_tree(directory[, name_req, ...])

Walk a directory tree and search for ThunderBoltz simulation directories to read.

tb.CrossSections.from_LXCat(fname)

Load cross section data from an LXCat .txt file

Cross Sections

CrossSections([directory, input_path, ...])

ThunderBoltz cross section set data type.

Process(process_type[, r1, r2, p1, p2, ...])

A reaction process determined by reaction and product indices, a process type, a potential threshold, and a corresponding cross section specification.

input.He_TB([n, egen, analytic_cs, eadf, ...])

Generate parameterized He cross section sets in the ThunderBoltz format.

input.convert(df, u1, u2[, inv, drop, add])

Convert easily between units with a labeled DataFrame.

Parallel Computing

parallel.MPRunner()

Interface for any kind of calculation that is run-able and set-able can be compatible with multiprocessing utilities like SlurmManager and DistributedPool.

parallel.DistributedPool(runner[, processes])

A multiprocessing Pool context for running calculations among cores with different settings.

parallel.SlurmManager(runner[, directory, ...])

A python context interface for the common Slurm HPC job manager to run more several intensive calculations on large clusters.