Metadata-Version: 2.1
Name: smurfs
Version: 1.0.4
Summary: Smart UseR Frequency analySer, a fast and easy to use frequency analyser.
Home-page: https://github.com/muma7490/SMURFS
Author: Marco Müllner
Author-email: muellnermarco@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: astropy (==3.2.1)
Requires-Dist: matplotlib (==3.1.1)
Requires-Dist: numpy (==1.17.2)
Requires-Dist: pandas (==0.25.1)
Requires-Dist: pytest (==5.1.2)
Requires-Dist: scipy (==1.3.1)
Requires-Dist: uncertainties (==3.1.2)
Requires-Dist: astroquery (==0.3.9)
Requires-Dist: lightkurve (==1.1.1)
Requires-Dist: eleanor (==0.2.8)
Requires-Dist: lmfit (==0.9.14)
Requires-Dist: jupyter (==1.0.0)
Requires-Dist: pyfcomb (==1.0.7)
Requires-Dist: Sphinx
Requires-Dist: nbsphinx

# SMURFS [![Build Status](https://travis-ci.org/muma7490/SMURFS.svg?branch=master)](https://travis-ci.org/muma7490/SMURFS)
![SMURFS Image](https://i.imgur.com/wWe1q0y.png)

**SMURFS** (**SM**art **U**se**R** **F**requency analy**S**er) is a simple program, that allows for a quick statistical analysis of variable stars 
using the LombScargle algorithm. It also allows for "splitting" such a dataset into equally sized chunks, to perform a 
time dependend analysis of the frequencies.

SMURFS is developed in Python3, using optimized scientific libraries like [numpy](http://www.numpy.org/), 
[scipy](https://www.scipy.org/) and [astropy](http://www.astropy.org/).

## Prerequisits
It is assumed that *git*,*python3* and *pip* are installed. If not, follow the installation instructions for 
[git](https://git-scm.com/), [python](https://www.python.org/) and [pip](https://pip.pypa.io/en/stable/installing/).

## Installation
It is recommended to create a new virtualenvironment.
```
cd SMURFS/
python3 -m venv venv/
source venv/bin/activate
```
Afterwarts, simply install it using pip
```
pip install smurfs
```
## Documentation

Full documenation is available [here](https://smurfs.readthedocs.io/en/master/)

## Features

SMURFS provides various nice to have features, setting it apart
from common frequency analysers. These include

* Python only. No more Fortran, IDL or other more obfuscating languages 
* Fast runs due to the usage of optimized libraries, including numpy, scipy and astropy,
dedicated to scientific work
* Generates a full result set that can be used for further analysis, including 
spectra of the first and last frequency, spectrograms, machine readable results and so on.


