_images/qsotools.png
https://img.shields.io/badge/License-MIT-blue.svg https://badge.fury.io/py/qsotools.svg https://img.shields.io/pypi/dm/qsotools https://zenodo.org/badge/DOI/10.5281/zenodo.597138.svg

This documentation aims to provide detailed information regarding the use of the QSOTOOLS program. The program provides a large number of tools to help researchers to speed up their quasar spectra data analysis. This program was built by Vincent Dumont and is part of the AstroQuasar group’s toolset available in our GitLab group .

Installation

The package is built around 5 dependent libraries ( astropy , matplotlib , numpy , pandas , and scipy ) and can be easily installed via the pip Python package manager as follows:

sudo pip install qsotools

Available operations

The program can be executed by simply typing qso in the terminal, the following operations are available:

coordinates (coord[, xdipp, ydipp])

Convert coordinates and get distance to alpha dipole.

distance (coord, **kwargs)

Spherical distance between 2 coordinates

coscal (z, **kwargs)

Cosmological Calculator.

edges (z, v, **kwargs)

Wavelength edges around given Lyman-alpha central redshift

omegab (dtoh, err, **kwargs)

Get baryon density from D/H values

rydberg (args)

Compute wavelength and energy of Rydberg atom

z2dv (z1, z2)

w2dv (w1, w2)

Examples

zshift (z, dv)

wshift (wa, dv)

alphadist (args)

Calculate da/a for distorted system


Program Execution

Below is the help message that will display if requested:

usage: qso [-h] {coordinates,distance,coscal,edges} ...

Toolset for quasar absorption line analysis.

positional arguments:
  {coordinates,distance,coscal,edges}
    coordinates         Convert coordinates
    distance            Spherical distance between 2 coordinates
    coscal              Cosmological calculator
    edges               Wavelength edges around Lyman-alpha

optional arguments:
  -h, --help            show this help message and exit

See '<command> --help' to read about a specific sub-command.

How to cite QSOTOOLS?

Please acknowledge QSOTOOLS in your publications using the following citation:

@software{qscan,
  author       = {Vincent Dumont},
  title        = {QScan: Quasar spectra scanning tool},
  month        = mar,
  year         = 2017,
  publisher    = {Zenodo},
  version      = {v1.0.0},
  doi          = {10.5281/zenodo.597138},
  url          = {https://doi.org/10.5281/zenodo.597138}
}

License Agreement

MIT License

Copyright (c) 2016-2018 Vincent Dumont

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Reporting issues

Submit a ticket

If you find any bugs when running this program, please make sure to report them by clicking on the above link and submit a ticket on the software’s official Gitlab repository.