Skip to main content

Infer the stellar obliquity distribution of transiting planet systems, following Morton & Winn (2014).

Makes use of the simpledist package, which will be installed as a dependency with installation of this package.

There are two main tasks this package does:

  1. Calculate posteriors of cos(I) given measurements of Rstar, Prot, Vsin(I).

  2. Infer the Fisher distribution parameter $kappa$ given a sample of cos(I) posteriors.

See below for a quick intro, and the notebook demo for more.

Installation

$ pip install [--user] obliquity

Or clone the repository and install:

$ git clone https://github.com/timothydmorton/obliquity.git
$ cd obliquity
$ python setup.py install [--user]

Basic usage

from obliquity.distributions import Cosi_Distribution
cosi_dist = Cosi_Distribution((1.3,0.1),(15,0.3),(3.5,0.5)) #Radius, Prot, VsinI
cosi_dist.summary_plot()

Command-line scripts

In addition to the obliquity module, this package also installs a few command-line scripts.

write_cosi_dist: This calculates a Cosi_Distribution given input parameters, and writes the distribution to file (.h5 format that can be easily re-loaded back). e.g.,

$ write_cosi_dist test.h5 -R 1.3 0.1 -P 14 0.3 -V 4 0.5

After having done this, you could launch up python and read in the distribution as follows:

from obliquity import Cosi_Distribution_FromH5
cosi_dist = Cosi_Distribution_FromH5('test.h5')
cosi_dist.summary_plot()

This is particularly useful for running batch jobs and doing more analysis later.

Metadata

Release files for obliquity 0.2

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

Source distribution (sdist)

Source distribution for obliquity 0.2
File Size Uploaded
obliquity-0.2.tar.gz 506.8 kB Details

Release files / obliquity-0.2.tar.gz

Download URL obliquity-0.2.tar.gz
Size 506.8 kB
Tags Source
SHA-256 checksum
How to use checksums
4ef062f74cae90d08ce670a4ebb265ac91d2a22d343da3890ade3fa2747d927d
BLAKE2b-256 checksum
How to use checksums
8e32997a706c93f3be76694aa5073e1084873155f696512fd8c901c7fe299f49
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.2 This release

1 release file

0.1

1 release file

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