Skip to main content

spelunker: a library to extract guidestar data and observe technical and stellar events

Project description

Spelunker — NIRISS FGS quicklook pipeline


spelunker is a package that assists and finds technical anomalies and stellar properties from guidestars.

Authors: Derod Deal (dealderod@ufl.edu), Néstor Espinoza (nespinoza@stsci.edu)

Statement of need

Every time JWST observes an object, it simultaneously observes a nearby star --- a so-called "guide star" --- with the NIRISS Fine Guidance Sensor (FGS) that is used to keep the telescope locked on the target of interest. While researchers typically focus on their science targets, the guide star data can be extremely interesting on its own right. On the one hand, telescope-level anomalies could be detected (and, in principle, corrected) using this guide star data. On the other, this data also provides a "free" sky survey in the infrared (0.6 to 5 microns), on which short (~hours to days) time series of stars are recorded --- which one could "mine" if a pipeline existed for it to search for, e.g., stellar variability or even exoplanet transits: a true treasure chest. Here we present a first version of an automated, public quick-look time-series data processing pipeline for NIRISS FGS data. The pipeline is able to generate time-series for several metrics of the FGS data in an automated fashion, including fluxes and PSF variations, along with derived products from those such as periodograms that can aid on their analysis given only a JWST program ID number.

Installation

To install spelunker, use pip install.

pip install spelunker

Using the library

Get started with spelunker with only two lines of code.

import spelunker

spk = spelunker.load('/Users/ddeal/JWST-Treasure-Chest/', pid=1534)

With our object spk, we can start interpeting data from guidestars, such as making a plot of the tracked guidestars within a Program ID.

spk.guidestar_plot()

We can also plot the timeseries of fitted gaussian parameters (use spk.gauss2d_fit to apply gaussian fitting to all guidestar frames) or the flux timeseries. Mnemonics from JWST technical events can be overplotted on any timeseries, such as high-gain antenna (HGA) movement or the FGS tracks a new guidestar.

import matplotlib.pyplot as plt

spk.mast_api_token = 'insert a token from auth.MAST here'

fig, ax = plt.subplots(figsize=(12,4),dpi=200)

ax = spk.mnemonics_local('GUIDESTAR')
ax = spk.mnemonics('SA_ZHGAUPST', 60067.84, 60067.9) 
ax.plot(spk.fg_time, spk.fg_flux)
plt.legend(loc=3)
plt.xlim(60067.84, 60067.9)
plt.show()

For more information on the tools under spelunker and how to get started, visit the quickstart guide. Get acquainted with spelunker with the following example notebooks:

Licence and attribution

This project is under the MIT License, which can be viewed 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

spelunker-0.5.4.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

spelunker-0.5.4-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file spelunker-0.5.4.tar.gz.

File metadata

  • Download URL: spelunker-0.5.4.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for spelunker-0.5.4.tar.gz
Algorithm Hash digest
SHA256 5b8a91dcde3e7f8651c73f0baaf4370cdd74df81a368a1e4dfff916f529cfc86
MD5 1047a7c1b6852e6af06f6aebc94f841d
BLAKE2b-256 e54326336a42b3afe2b988951d45ce9665e9c42b11c6ee9099115fa98c86ad29

See more details on using hashes here.

File details

Details for the file spelunker-0.5.4-py3-none-any.whl.

File metadata

  • Download URL: spelunker-0.5.4-py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for spelunker-0.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 dc7fb09ca306a23aedfc83ec55f3616352ce7d232b5de3a6e961ed136474a684
MD5 407a9285a465ade3f9e6eea1622fd04c
BLAKE2b-256 4017ecb0aba4a008bc89f78f0f1a4b2d904c80793025d4bee55deb81ba229740

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