Software Documentation

This documentation aims to provide detailed information regarding the use of the Velplot program. The program was built by Vincent Dumont and is part of the Astroquasar group’s toolset available in our GitLab group . The easiest way to install the software is using the PyPI package manager as follows:

pip install velplot

You can specified the release version as follows:

pip install velplot==1.2.4

Getting Started

Modules description

Extracting fitting model

read_fort13 (fortfile, lastchtied, atom[, …])

Read fort.13 and store fitted parameters in array.

read_fort26 (fortfile, lastchtied, atom[, …])

Read fort.26 and store fitted parameters in array.

get_dv (header, table1, comment, atom[, …])

Calculate central redshift and velocity dispersion.

get_trans (comment, overlaptrans)

Find transition part of overlap system, if existing.

Storing atomic data

isfloat (value)

Check if given value is of float type or not

atom_list (atompath)

Create list of atomic data based on input atom.dat

atom_info (atomID, atom)

Get atomic data from selected atomID

atom_mass (species)

Store ion mass extracted from atom.dat

Executing VPFIT

make_setup ([atomdir, vpsetup])

create_chunks (fortfile, table1, header, …)

Generate data chunk for each fitted region.

fit_fort (fortfile, fit, error, illcond, …)

Do Voigt fitting and update model.

Plotting functions

make_figure (fortfile[, atomdir, details, …])

Main function to create velocity plot.

check_shift (i, dvmin, dvmax, table1, table2, …)

Check applied shifts, zero or continuum levels in input model.