Skip to main content

Smart UseR 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.Smart UseR Frequency analySer

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

To install SMURFS, simply run the following command:

pipx install smurfs

if you don't have pipx installed, check here for instructions.

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-2.0.0rc7.tar.gz (31.3 kB view details)

Uploaded Source

Built Distribution

smurfs-2.0.0rc7-py3-none-any.whl (40.8 kB view details)

Uploaded Python 3

File details

Details for the file smurfs-2.0.0rc7.tar.gz.

File metadata

  • Download URL: smurfs-2.0.0rc7.tar.gz
  • Upload date:
  • Size: 31.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for smurfs-2.0.0rc7.tar.gz
Algorithm Hash digest
SHA256 5adb60a75f6f0a37cd3d1b8457233558ecb276d6806ebbff3f89d1ac2767d5e2
MD5 e9d4f38535a2542f1014f9f2fba617fd
BLAKE2b-256 01ed179d5d4f84c23bfbc467e76660e72393ef175e56d194b51b7fcdc6476179

See more details on using hashes here.

Provenance

The following attestation bundles were made for smurfs-2.0.0rc7.tar.gz:

Publisher: cd.yaml on MarcoMuellner/SMURFS

Attestations:

File details

Details for the file smurfs-2.0.0rc7-py3-none-any.whl.

File metadata

  • Download URL: smurfs-2.0.0rc7-py3-none-any.whl
  • Upload date:
  • Size: 40.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for smurfs-2.0.0rc7-py3-none-any.whl
Algorithm Hash digest
SHA256 41c4a953b6eb3e8eabf2a6f67147c3aad5afc11bd66495ad65ceb1e894ef9a3c
MD5 c1de990bcb0700e08f119dae95077162
BLAKE2b-256 5b2397a0d061cb9a2122bbf3e5af8a0e2938f6c5509776030def41ba62585590

See more details on using hashes here.

Provenance

The following attestation bundles were made for smurfs-2.0.0rc7-py3-none-any.whl:

Publisher: cd.yaml on MarcoMuellner/SMURFS

Attestations:

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