vspec

Variable Star PhasE Curve: A Python tool that uses the NASA Planetary Spectrum Generator (PSG) and a variable star model to simulate observations of exoplanets.

https://github.com/vspec-collab/vspec

Keywords

Repository

Variable Star PhasE Curve: A Python tool that uses the NASA Planetary Spectrum Generator (PSG) and a variable star model to simulate observations of exoplanets.

docs/readme.rst

.. image:: https://vspec-collab.github.io/VSPEC/latest/_images/vspec_logo.png
    :width: 400
    :alt: VSPEC Logo
    :align: center

|Documentation Status| |MIT license| |EMAC Badge|

.. |Documentation Status| image:: https://github.com/VSPEC-collab/VSPEC/actions/workflows/build-docs.yml/badge.svg
   :target: https://vspec-collab.github.io/VSPEC

.. |MIT license| image:: https://img.shields.io/badge/License-MIT-blue.svg
   :target: https://lbesson.mit-license.org/

.. |EMAC Badge| image:: https://img.shields.io/badge/EMAC-2401--001-blue
   :target: https://emac.gsfc.nasa.gov?cid=2401-001

.. image:: https://coveralls.io/repos/github/VSPEC-collab/VSPEC/badge.svg?branch=main
   :target: https://coveralls.io/github/VSPEC-collab/VSPEC?branch=main



VSPEC: Variable Star PhasE Curve
================================

VSPEC combines NASA's Planetary Spectrum Generator (PSG) with a custom stellar model
to produce phase curves of variable host + planet systems.

Documentation
-------------

VSPEC's documentation is hosted `here `_.
There you can find a description of the API as well as numerous examples.

How to Cite
-----------

A paper describing the code has been published in *Astronomy & Computing*. Please cite `this paper `_ if you use ``VSPEC``.

Additionally, the ``CITATION.cff`` file in this repository contains citation information for specific ``VSPEC`` versions.

Authors
-------

VSPEC was written by CRESST II post-baccs Cameron Kelahan and Ted Johnson with support
from many others. See Authors.md for more info.

VSPEC is currently maintained by Ted Johnson

Questions
---------

To report bugs, ask questions, and request features please use the Issues page or email the authors.

Contributing
------------

Please reach out if you are interested in contributing to this project!

Owner

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: VSPEC
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Ted
    family-names: Johnson
    email: ted.johnson@unlv.edu
    affiliation: 'NASA GSFC, UNLV'
    orcid: 'https://orcid.org/0000-0002-1570-2203'
  - given-names: Cameron
    family-names: Kelahan
    orcid: 'https://orcid.org/0009-0002-0075-8041'
    affiliation: NASA GSFC
  - given-names: Tobi
    family-names: Hammond
    affiliation: NASA GSFC
    orcid: 'https://orcid.org/0009-0002-5756-9778'
repository-code: 'https://github.com/VSPEC-collab/VSPEC'
abstract: >-
  VSPEC (Variable Star PhasE Curve) is an exoplanet modeling
  suite that combines NASA’s Planetary Spectrum Generator
  (PSG) with a custom variable star (based on the spotty and
  xoflares packages).


  VSPEC is a general exoplanet observation modeling suite
  that is built to be modular. VSPEC can simulate phase
  curves of non-transiting planets, transits, eclipses, and
  direct-imaging spectroscopy. It uses a noise model from
  PSG, which is sophisticated enough to simulate realistic
  data for a variety of scenarios.


  The original motivation for VSPEC was to create synthetic
  datasets of Planetary Infrared Excess (PIE) observations,
  but the code is much more general.
keywords:
  - Exoplanet
  - Open-source
  - Planetary Spectrum Generator
license: MIT
version: 1.1.0

GitHub Events

Packages