SMURFS
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.
If you use SMURFS to extract LC data from FFIs, you should also cite the awesome people of Eleanor.
Documentation
Full documentation is available here
1 maintainer
Metadata
1 maintainer
Release files for smurfs 1.1.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| smurfs-1.1.6.tar.gz | 29.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| smurfs-1.1.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 63.2 kB
Release files / smurfs-1.1.6.tar.gz
| Download URL | smurfs-1.1.6.tar.gz |
|---|---|
| Size | 29.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6010c0e917181331ffefa0d5bd9f2119128e8e352d6fe69536e752b09917d5bc
|
|
BLAKE2b-256 checksum How to use checksums |
6c1ee22c80b33fd85e95d130738ddaacd234de9360f6271a77e000d279f3fa58
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.6.10
|
Release files / smurfs-1.1.6-py3-none-any.whl
| Download URL | smurfs-1.1.6-py3-none-any.whl |
|---|---|
| Size | 33.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a87e6c525d6edcb2fd9f09d6cd697139e3901e0591664b5a1df6bc2ca1f0b41e
|
|
BLAKE2b-256 checksum How to use checksums |
449f13c715c05b82b5bbed2ec20ae38b27ae29e24d8c60157168c665c7c7fcc1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.6.10
|
Security for smurfs 1.1.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
