Metadata-Version: 2.1
Name: varana
Version: 0.1.2
Summary: Analyse the variability of stars
Home-page: https://github.com/pbrus/variability-analyser/tree/master/varana
Author: Przemysław Bruś
License: UNKNOWN
Keywords: variability,time,series,stars,magnitude
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: scikit-learn

# Varana
[![Build Status](https://travis-ci.org/pbrus/variability-analyser.svg?branch=master)](https://travis-ci.org/pbrus/variability-analyser)
[![Code](https://img.shields.io/badge/code-Python-blue.svg "Python")](https://www.python.org/)
[![PyPI version](https://badge.fury.io/py/varana.svg)](https://badge.fury.io/py/varana)
[![License](https://img.shields.io/badge/license-MIT-yellow.svg "MIT license")](https://github.com/pbrus/variability-analyser/varana/blob/master/LICENSE)

This module determines the variability of stars through analyzing their time series.

![varana](http://www.astro.uni.wroc.pl/ludzie/brus/img/github/varana.gif)

## Installation

To install the package please type from the command line:
```bash
$ sudo pip3 install varana
```

## Usage

This module is the part of a larger tool - [variability-analyser](https://github.com/pbrus/variability-analyser). Despite of that it can be used separately. The module is divided into smaller scripts which can be called independently. You can use the following scripts:

+ `detrend.py`
+ `trim.py`
+ `freq_comb.py`
+ `fit.py`
+ `phase.py`
+ `plt_pdgrm.py`

To see what they do please call them with the `-h` option, for example:
```bash
$ detrend.py -h
```

## License

The **varana** module is licensed under the [MIT license](http://opensource.org/licenses/MIT).


