The API

The vspec-vsm API is described below.

vspec_vsm Package

Most of the interface is defined in by the Star class.

Classes

CoordinateGrid()	Base class for all coordinate grids.
Facula(lat, lon, r_max, r_init, depth, ...)	A small magnetic depression with a cool floor and hot walls.
FaculaCollection(*faculae[, grid_params, ...])	Container class to store faculae.
FaculaGenerator(dist_r_peak, ...)	Facula Generator
FlareCollection(flares)	This class stores a series of flares and does math to turn them into lightcurves.
FlareGenerator(dist_teff_mean, ...)	Generator for flare events and their characteristics.
Granulation(mean_coverage, amplitude, ...[, ...])	Class to contain the granulation model
GranulationKernel(scale, period)	GP Kernel to describe Granulation
SpotCollection(*spots[, grid_params, gridmaker])	Container holding StarSpot objects
SpotGenerator(dist_area_mean, ...[, ...])	Spot Generator
Star(teff, radius, period, spots, faculae, ...)	Star object representing a variable star.
StarSpot(lat, lon, area_max, area_current, ...)	A Star Spot
StellarFlare(fwhm, energy, lat, lon, Teff, tpeak)	Class to store and control stellar flare information