Skip to main content

Package with useful functions for exoplanetary research

Project description

Planet Tools

Useful functions to perform everyday conversions and calculation of quantities in exoplanetary science. It is a work in progress, so I am constantly adding and modifying them.

license: MIT PyPI version

To install

pip install Planet-tools

or

git clone https://github.com/tundeakins/Planet_tools.git
cd Planet_tools
python setup.py install

The convert_params module contains the following functions:

  • P_to_aR - convert period to scaled semi-major axis.

  • aR_to_rho_star - Compute transit derived stellar density from the planet period and scaled semi major axis

  • impact_parameter - Convert inclination to impact parameter b

  • inclination - Convert impact parameter b to inclination in degrees.

  • convert_LD_coeffs - Convert between different LD laws The calculate_params module contains the follwing functions:

  • RL_Rroche - Calculate ratio of Laplace radius to Roche radius

  • R_hill - Compute the hill radius of a planet

  • R_roche - Compute roche radius of a planet as a function of the planet's radius

  • T_eq - Calculate equilibrium temperature of planet in Kelvin

  • ingress_duration - Calculate the duration of ingress/egress.

  • ldtk_ldc - Estimate quadratic limb darkening coefficients for a given star

  • phase_fold - Given the observation time and period, return the phase of each observation time

  • planet_prot - Calculate period of rotation of a planet

  • sigma_CCF - Calculate CCF width of non-rotating star in km/s based on resolution of spectrograph

  • transit_duration - Calculate the transit duration

The estimate_effect module contains the following functions:

  • photo_granulation - Estimate the amplitude and timescale of granulation noise in photometric observations as given by Gilliland 2011
  • chaplin_exptime - Compute the optimal exposure time to reduce stellar p-mode oscillation amplitude in the given star to 0.1m/s and 0.09m/s according to Chaplin et al. 2019.
  • rv_precision_degrade - Calculate factor by which RV precision of a stellar spectral type degrades due to vsini.

The some_stats module contains the following functions:

  • bic - Compute the bayesian information criteria
  • aic - Calculate the Aikake information criterion.
  • rmse - Calculate the root-mean-square of the inputed error array (residuals)
  • sse - Calculate the sum of squared error of inputed error array (residuals)
  • mse - Calculate the mean-square error of imputed error array
  • mae - Calculate the mean-absolute error of imputed error array
  • rse - Calculate the relative-square error from the observed and calculated values
  • rae - Calculate the relative-absolute error from the observed and calculated values
  • r_squared - Calculate the R2_score commonly

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

Planet_tools-0.4.0.tar.gz (35.0 kB view details)

Uploaded Source

Built Distribution

Planet_tools-0.4.0-py3-none-any.whl (40.8 kB view details)

Uploaded Python 3

File details

Details for the file Planet_tools-0.4.0.tar.gz.

File metadata

  • Download URL: Planet_tools-0.4.0.tar.gz
  • Upload date:
  • Size: 35.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.5

File hashes

Hashes for Planet_tools-0.4.0.tar.gz
Algorithm Hash digest
SHA256 a9fd9c61e021dffdbb8fa0cfa66e855b102169207203cd9c0ace9fa53403af7b
MD5 5d50b3b8636e7dd47adbd26b6c20b9d3
BLAKE2b-256 de48cef87894d1d689d89985e4778da339eca7894cf7897b2671efcd967dc983

See more details on using hashes here.

File details

Details for the file Planet_tools-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for Planet_tools-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c7c9e5cbc5c706a3f3ab3c4d7e22e8e9cb2b06cefe35ef8f0f691ae5829419cb
MD5 8d2741156138ef0c8ce02297dd4ecc20
BLAKE2b-256 a348f0fc8e55d7c19775b9bced1ac19b49bd442944f8a7c7378d5baa6c864dbd

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