Input

class nexoclom.Input(infile)

Bases: object

Read the input options from a file.

Parameters

infile

Plain text file containing model input parameters. See Input File Format for a description of the input file format.

Class Attributes

• geometry

• surface_interaction

• forces

• spatialdist

• speeddist

• angulardist

• options

Methods Summary

search()	Search the database for previous model runs with the same inputs.
produce_image(format_[, filenames, overwrite])
run(npackets[, packs_per_it, overwrite, …])	Run the nexoclom model with the current inputs.

Methods Documentation

search()

Search the database for previous model runs with the same inputs. See searchtolerances for tolerances used in searches.

Parameters

No parameters.

Returns

• A list of filenames corresponding to the inputs.

• Number of packets contained in those saved outputs.

• Total modeled source rate.

produce_image(format_, filenames=None, overwrite=False)

run(npackets, packs_per_it=None, overwrite=False, compress=True)

Run the nexoclom model with the current inputs.

Parameters

npackets

Number of packets to simulate

packs_per_it

Maximum number of packets to run at one time. Default = 1e5 in constant step-size mode; 1e6 in adaptive step-size mode.

overwrite

Erase any files matching the current inputs that exist. Default = False

compress

Remove packets with frac=0 from the outputs to reduce file size. Default = True

Outputs

Nothing is returned, but model runs are saved and cataloged.