Skip to main content

Smart UseR Frequency analySer, a fast and easy to use frequency analyser.

Project description

SMURFS

SMURFS Image

SMURFS provides automatic extraction of frequencies from timeseries. It provides various interfaces, from a standalone command line tool, to jupyter and python integrations and computes possible frequency combinations, directly downloads and reduces (if necessary) data of TESS/Kepler/K2 observations and much much more.

Getting started

To install smurfs, you need python > 3.5, pip as well as cmake. If you don't have these, install them through the packet manager of your choice (f.e. brew(Mac) or apt (Debian)). For pip check here.

Installation

First off, create a virtual environment

cd /Path/
python3 -m venv venv/
source venv/bin/activate

Install smurfs through pip

pip install smurfs

Quickstart

Using SMURFS as a standalone command line tool is very simple. Simply call smurfs with a target, signal to noise ratio cutoff and the window size. The target can be either:

  • A path to a file, containing 2 columns with time and flux
  • Any name of a star, that is resolvable by Simbad and has been observed by the Kepler,K2 or TESS missions.

As an example, we can take a look at the star Gamma Doradus:

smurfs "Gamma Doradus" 4 2

SMURFS creates a result folder after running the code. In this case it has the following structure

- Gamma_Doradus
    - data
        - _combinations.csv
        - _result.csv
        - LC_residual.txt
        - LC.txt
        - PS_residual.txt
        - PS.txt         
    - plots
        - LC_residual.pdf
        - LC.pdf
        - PS_residual.pdf
        - PS_result.pdf
        - PS.pdf

The LC*.txt files contain the light curves, original and residual. The PS*.txt files contain the original as well as the residual amplitude spectrum. _combinations.csv shows all combination frequencies for the result and _result.csv gives the result for a given run.

Citing

If you use this software in your research, consider citing it using Zenodo.

DOI

If you use SMURFS to extract LC data from FFIs, you should also cite the awesome people of Eleanor.

Feinstein et al. 2019

Documentation

Full documentation is available here

Project details


Download files

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

Source Distribution

smurfs-1.1.8.tar.gz (30.1 kB view details)

Uploaded Source

Built Distribution

smurfs-1.1.8-py3-none-any.whl (35.3 kB view details)

Uploaded Python 3

File details

Details for the file smurfs-1.1.8.tar.gz.

File metadata

  • Download URL: smurfs-1.1.8.tar.gz
  • Upload date:
  • Size: 30.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.3

File hashes

Hashes for smurfs-1.1.8.tar.gz
Algorithm Hash digest
SHA256 2f00e291ce1be02d519a485b151b1a374a7b26bcde8341291777f4da346cbe61
MD5 294c849701a504ff04f2099c96d2c342
BLAKE2b-256 ee8140a59ad96b45dd94daf4901f3a1aafb79049b2b94916a68d8c0aeab8e83f

See more details on using hashes here.

File details

Details for the file smurfs-1.1.8-py3-none-any.whl.

File metadata

  • Download URL: smurfs-1.1.8-py3-none-any.whl
  • Upload date:
  • Size: 35.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.3

File hashes

Hashes for smurfs-1.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 d0dbe6965c940231e805f25f311e62193bde9d56b721ffdbc0b4ecfd3d4d8c19
MD5 8c1b7fbd400cb65f3ebd6a5bf891bfbd
BLAKE2b-256 71240c67c67b8662fdef9f37c6b8c821334ef7e82d1c3b769cf7d3b3df021e47

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page