Access the exoplanets.org data base

class PyAstronomy.pyasl.ExoplanetsOrg(skipUpdate=False, verbose=False)

Easy access to explanets.org exoplanet archive.

This class downloads a table of exoplanet data from the explanets.org (http://exoplanets.org/csv-files/) and provides access to these data. By default, the data will be re-downloaded every seven days.

The following data are provided:

Column	Description	Unit
pl_name	Name of the planet
pl_orbper	Planetary orbital period	d
pl_massj	Planetary mass	MJ
pl_msini	Minimum planetary mass	MJ
pl_radj	Planetary radius	RJ
pl_trandep	Central depth of transit	%
pl_impact	Impact Parameter	Stellar Radii
pl_trandur	Transit duration	d
pl_tranmid	Transit midpoint	BJD
pl_tperi	Time of Periastron passage	BJD
pl_orbsmax	Semi-major-axis	AU
pl_orbsmaxr	Semi-major-axis / R_star	Stellar Radii
pl_orbincl	Orbital inclination of planet	deg
pl_missal	Orbital misalignment of planet	deg
pl_omega	Argument of Periastron	deg
pl_ecc	Planetary orbital eccentricity	%
pl_grav	Planetary surface gravity	log10(cm/s^2)
pl_dens	Planetary Density	g/cm^3
pl_dtype	Detection type	%
KOI	Kepler ID (if available)
pl_hostname	Name of host star
st_binary	Binary Flag
st_rad	Stellar radii	Solar
st_dist	Distance to star	pc
st_par	Stellar parallax	mas
st_mass	Stellar mass	Solar
st_teff	Effective temperature of star	K
st_vsini	Stellar vsin(i)	km/s
st_logg	Stellar surface gravity	cm/s**2
st_acts	Stellar S-Index
st_actc	Stellar chromospheric activity
st_vj	Stellar V-band brightness	mag
st_fe	Stellar metallicity
st_radv	System radial velocity	km/s
st_dens	Density of star	g/cm**3
K	Velocity Semi-amplitude	m/s
dec	Declination (J2000)	dms
ra	Right ascension (J2000)	hms

Methods

availableColumns([verbose])	Shows a list of available data columns.
changeDownloadCycle(c)	Change the time after which the data are updated.
dataAge()	Determine the "age" of the data.
downloadData()	Trigger download of data.
getAllData()	Get all available data.
needsUpdate()	Determine whether data need to be updated.
selectByPlanetName(planetName[, caseSensitive])	Get entry by planet name.

availableColumns(verbose=True)

Shows a list of available data columns.

Parameters

verboseboolean, optional

If True (default), prints information to screen.

Returns

columnslist of strings

The names of the available data columns.

changeDownloadCycle(c)

Change the time after which the data are updated.

By default, the data will be updated if they are older than the given update cycle. This method allows you to change that cycle.

Parameters

cfloat or None

The new update cycle in days. If None is provided, updating is switched off.

dataAge()

Determine the “age” of the data.

Returns

agefloat

The time since last data update in days. None, if no age can be determined, e.g., if data have never been downloaded.

downloadData()

Trigger download of data.

getAllData()

Get all available data.

Returns

Datanumpy recarray

All data stored in the table as a numpy recarray.

needsUpdate()

Determine whether data need to be updated.

Returns

Update flagboolean

True if data need update and False otherwise.

selectByPlanetName(planetName, caseSensitive=False)

Get entry by planet name.

Parameters

planetNamestring

The name of the planet (includes planet letter, e.g., “corot-2 b”

caseSensitiveboolean, optional

If False (default), the search will be case-insensitive.

Returns

Data entrydictionary

A dictionary with a key for every data column holding the associated value from the data table.

Example of usage

from __future__ import print_function, division
from PyAstronomy import pyasl

# Instantiate the access class
epl = pyasl.ExoplanetsOrg()

# Show the available columns
epl.availableColumns()

# Get information in Kepler-5 b
d = epl.selectByPlanetName("kepler-5 b")

# Print whatever information has been received
print()
print("Information on Kepler-5 b")
print()
for k, v in list(d.items()):
  print("%12s  %12s" % (k,str(v)))