Skip to main content

Gyrochronology via interpolation of open cluster rotation sequences.

Project description

gyrointerp

Documentation

The documentation is hosted at gyro-interp.readthedocs.io. A minimal example to get you started is below.

Install

Preferred installation method:

pip install gyrointerp

Or

git clone https://github.com/lgbouma/gyro-interp
cd gyro-interp
python setup.py install

Minimal Example

Given a single star's rotation period, effective temperature, and uncertainties, what is the gyrochronological age posterior over a grid spanning 0 to 2.6 Gyr?

  import numpy as np
  from gyrointerp import gyro_age_posterior

  # units: days
  Prot, Prot_err = 11, 0.2

  # units: kelvin
  Teff, Teff_err = 4500, 100

  # uniformly spaced grid between 0 and 2600 megayears
  age_grid = np.linspace(0, 2600, 500)

  # calculate the age posterior - takes ~30 seconds
  age_posterior = gyro_age_posterior(
      Prot, Teff, Prot_err=Prot_err, Teff_err=Teff_err, age_grid=age_grid
  )

  # calculate dictionary of summary statistics
  from gyrointerp import get_summary_statistics
  result = get_summary_statistics(age_grid, age_posterior)

  print(f"Age = {result['median']} +{result['+1sigma']} -{result['-1sigma']} Myr.")

The documentation contains more extensive examples, as well as discussion of important caveats.

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

gyrointerp-0.2.tar.gz (13.1 MB view details)

Uploaded Source

File details

Details for the file gyrointerp-0.2.tar.gz.

File metadata

  • Download URL: gyrointerp-0.2.tar.gz
  • Upload date:
  • Size: 13.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.8

File hashes

Hashes for gyrointerp-0.2.tar.gz
Algorithm Hash digest
SHA256 509f7a0b2bc98430d86802cfd1f7f5f5542ec13696d12b627d2fc42766e2f3bc
MD5 f14e8f3d32337ba03355d038c18481b4
BLAKE2b-256 6a0b60207edf4088690a8c2cc2dcc0163f80add453b7dbc40c3dbb35fb39c06c

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