gwdetchar / hveto

A python implementation of the Hierarchichal Veto (hveto) algorithm
GNU General Public License v3.0
5 stars 11 forks source link
detector-characterization gravitational-waves python

================= Hierarchical Veto

Hveto is a python implementation of the HierarchicalVeto algorithm. It is a package designed for gravitational-wave detector characterisation and data quality.

The Hveto algorithm is fully described in Smith et al. 2011_ (Classical and Quantum Gravity).

|PyPI version| |Conda version|

|DOI| |License| |Supported Python versions|

|Build Status| |Coverage Status| |Documentation Status|

https://hveto.readthedocs.io


Installation

Hveto is best installed with conda_:

.. code:: bash

conda install -c conda-forge hveto

but can also be installed with pip_:

.. code:: bash

python -m pip install hveto


Contributing

All code should follow the Python Style Guide outlined in PEP 0008; users can use the flake8 package to check their code for style issues before submitting.

See the contributions guide_ for the recommended procedure for proposing additions/changes.

.. _PEP 0008: https://www.python.org/dev/peps/pep-0008/ .. _flake8: http://flake8.pycqa.org .. _the contributions guide: https://github.com/gwdetchar/hveto/blob/master/CONTRIBUTING.md .. _conda: https://conda.io .. _pip: https://pip.pypa.io/en/stable/ .. _Smith et al. 2011: //dx.doi.org/10.1088/0264-9381/28/23/235005

.. |PyPI version| image:: https://badge.fury.io/py/hveto.svg :target: http://badge.fury.io/py/hveto .. |Conda version| image:: https://img.shields.io/conda/vn/conda-forge/hveto.svg :target: https://anaconda.org/conda-forge/hveto/ .. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/2584615.svg :target: https://doi.org/10.5281/zenodo.2584615 .. |License| image:: https://img.shields.io/pypi/l/hveto.svg :target: https://choosealicense.com/licenses/gpl-3.0/ .. |Supported Python versions| image:: https://img.shields.io/pypi/pyversions/hveto.svg :target: https://pypi.org/project/hveto/ .. |Build Status| image:: https://github.com/gwdetchar/hveto/actions/workflows/build.yml/badge.svg :target: https://github.com/gwdetchar/hveto/actions/workflows/build.yml .. |Coverage Status| image:: https://codecov.io/gh/gwdetchar/hveto/branch/master/graph/badge.svg :target: https://codecov.io/gh/gwdetchar/hveto .. |Documentation Status| image:: https://readthedocs.org/projects/hveto/badge/?version=stable :target: https://hveto.readthedocs.io/en/stable/?badge=stable