vspec-collab / 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.

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 on readthedocs here. There you can find a description of the API as well as numerous examples.

How to Cite

A JOSS paper describing VSPEC is in the works.

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!

vspec's Issues

Shift creation of vsm objects to VSPEC

This way pypsg does not have any dependency on VSPEC

We lack a framework to allow new grids.

Currently we always use the GridPolator VSPEC grid. Let's create some framework to allow other grids.

Create switch to turn off generator-cont-stellar

generator-cont-stellar is typically set to N, in VSPEC it is automatically set to Y

Upgrade `pypsg` to latest

The latest pypsg release is 0.2.0,

Use pypsg to interact with PSG API

Use Gridpolator to handle stellar spectra

Update to `pypsg` v0.1.0

Update according to the initial release of pypsg.

Create switch to turn off heat balance enforcement

Currently enforced here:

VSPEC/VSPEC/gcm/structure.py

Lines 375 to 379 in 6d31461

	is_valid = validate_energy_balance(
	dat,lons,lats,star_teff,albedo,r_star,r_orbit
	)
	if not is_valid:
	raise ValueError('Energy balance off by more than 1%. Generally, this is caused by low spatial sampling')

Files in the `scripts` directory are obsolete

They should have been removed with the PHOENIX grid

`VSPEC.waccm.write_psg.get_pycfg` passes bytes object instead of `np.ndarray`

In

VSPEC/VSPEC/waccm/write_psg.py

Lines 182 to 188 in 6d31461

	return pypsg.PyConfig(
	atmosphere=pypsg.cfg.EquilibriumAtmosphere.from_cfg(params),
	gcm=GCM(
	header=params['ATMOSPHERE-GCM-PARAMETERS'],
	dat=buffer.getvalue()
	)
	)

dat is passed as a bytes object, but a numpy.ndarray is expected.

Typing hints specifying units cause `TypeError` for Python < 3.9

For example:

File "~/Documents/vspec/VSPEC/VSPEC/helpers/misc.py", line 12, in <module>
system_distance: u.Quantity[u.pc],
TypeError: 'type' object is not subscriptable

Create a generalized way to load a GCM

Right now we specifically support WACCM GCMs. Let's create a more generalized framework so that other types of GCMs can be used.

Error during `build_spectra` when planet name contains spaces

When the planet name contains spaces, PSG converts the spaces to dashes. This causes an error when trying to access the returned spectra. For example 'prox cen b' --> 'prox-cen-b'. This should be an easy fix but we should make sure to find all instances.