Skip to main content

Diagnostic tools for the advanced LIGO timing distribution system.

Project description

# GECo Statistics Reports

[![PyPI Version](https://img.shields.io/pypi/v/geco-stat.svg)](https://pypi.python.org/pypi/geco-stat)
[![PyPI Project Status](https://img.shields.io/pypi/status/geco-stat.svg)](https://pypi.python.org/pypi/geco-stat)
[![Documentation Status](https://readthedocs.org/projects/geco-statistics/badge/?version=latest)](http://geco-statistics.readthedocs.org/en/latest/?badge=latest)

Master build status on Travis CI: [![Master build Status](https://travis-ci.org/stefco/geco_stat.svg?branch=master)](https://travis-ci.org/stefco/geco_stat)

Dev build status on Travis CI: [![Dev build Status](https://travis-ci.org/stefco/geco_stat.svg?branch=dev)](https://travis-ci.org/stefco/geco_stat)

Master build status on Codeship: [![Codeship Test Status](https://img.shields.io/codeship/e9762300-bd59-0133-0ed3-2a1d867cc1c8/master.svg)](https://codeship.com/projects/136547)

## Purpose

`geco_stat` can be used to easily generate histograms, statistics, and
anomaly reports for timing signals generated by LIGO interferometers. It is
meant to simplify the handling of massive amounts of diagnostic data by
providing a simple, organized interface to relevant statistics, easy
progress tracking for large jobs, effortless data visualization, and convenient
ways to combine reports, so that very long timeseries can be efficiently
analyzed in parallel and then recombined into single, monolithic reports
covering entire eras.

## Getting Started

If you just want to use the latest stable version, you can install it with `pip`:

```bash
pip install geco_stat
```

If you are on an environment without root privileges, you can do this by
creating a virtual environment using `virtualenv` in the folder where you
would like to work:

```bash
cd /path/to/working_directory
virtualenv env

# use the virtualenv version of python and pip
source env/bin/activate
pip install geco_stat
```

When finished with your virtual environment, you can exit it by simply running
`deactivate`.

To use the module from this repository for development, run:
```bash
git clone git@github.com:stefco/geco_stat.git
```

There is a Makefile included for automating most tasks. To get started, run
`make env`, which will configure a virtual environment for development.

You can simply type `make` to see a list of targets for `make` (i.e. commands you
can have `make` execute).

You can run `make test` to run unit and doctests, `make build` to build a
package for upload to PyPI, `make upload` to upload it, `make check` to make
sure everything is set up (and to see whether you are in a virtual environment),
`make html` to generate documentation html files (though they will have a
different theme than those on Read The Docs), `make clean` to delete
autogenerated files, and `make distclean` to delete *all* autogenerated files
and folders (including the `env` directory).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for geco-stat, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size geco_stat-0.2.2.tar.gz (19.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page