Skip to main content

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

or

pip install git+https://github.com/tundeakins/Planet_tools.git

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

Metadata

Release files for Planet-tools 0.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for Planet-tools 0.4.1
File Size Uploaded
planet_tools-0.4.1.tar.gz 46.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for Planet-tools 0.4.1
File Interpreter ABI Platform
planet_tools-0.4.1-py3-none-any.whl Python 3 none any Details

Total release size: 97.7 kB

Release files / planet_tools-0.4.1.tar.gz

Download URL planet_tools-0.4.1.tar.gz
Size 46.7 kB
Tags Source
SHA-256 checksum
How to use checksums
7375aee8ed51e97ee1e75e23c3bc34b51708916844d158423966913c51c59312
BLAKE2b-256 checksum
How to use checksums
cc187b38c162f688d1ac00ae94abfa2d7ca3acbcb6fd561910523fba2da8cf7d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.16

Release files / planet_tools-0.4.1-py3-none-any.whl

Download URL planet_tools-0.4.1-py3-none-any.whl
Size 51.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
923166f23553be77006c8712e9ddc6513c43817167d515a8c88d121ab4c90679
BLAKE2b-256 checksum
How to use checksums
d86deb6611092aa3d10b5cd000d668760361d0a315384af99e351915eeaaaea0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.16

Release history Release notifications | RSS feed

This release

0.4.1 This release

2 release files

0.4.0

2 release files

0.3.9

2 release files

0.3.8

2 release files

0.3.7

2 release files

0.3.6

2 release files

0.3.2

1 release file

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.5

2 release files

0.2.3

2 release files

0.1.9

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.0.9

2 release files

0.0.7

3 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

3 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page