Skip to main content

# barycorrpy (v0.3.6)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1115856.svg)](https://doi.org/10.5281/zenodo.1115856)

[Barycorrpy](http://iopscience.iop.org/article/10.3847/2515-5172/aaa4b7) is the Python version of Jason Eastman and Jason Wright’s IDL code [BaryCorr](http://astroutils.astronomy.ohio-state.edu/exofast/pro/exofast/bary/zbarycorr.pro) based on [Wright and Eastman (2014)](https://arxiv.org/pdf/1409.4774.pdf). BCPy can be used to calculate the barycentric velocity correction for a star with an accuracy well below 1 cm/s . To do this, it takes into consideration the following effects-

  1. Revolution of the Earth to consider position and velocity of the geocenter with respect to the Solar System barycenter

  2. Rotation of the Earth

  3. Precession, nutation and polar motion of the Earth, along with the above to calculate the position and velocity of the observatory with respect to the geocenter

  4. Gravitational time dilation due to objects of the Solar System

  5. Leap second offset

  6. Proper motion and systemic radial velocity of the star

  7. Parallax

  8. Shapiro delay

The installation instructions and the guide on how to run and use the code are explained in the [wiki](https://github.com/shbhuk/barycorrpy/wiki

There is also a video tutorial (courtesy of the [Exoplanet Modeling and Analysis Center](https://emac.gsfc.nasa.gov/) ) available [here](https://www.youtube.com/watch?v=5SqmL6TdJjs), describing how to get started with barycorrpy.

It is important to note that the code does not just output a barycentric velocity which must be subtracted from the raw Radial Velocity. It outputs the net radial velocity after correcting for barycentric correction. This is because the correction involves a cross term due to the relativistic addition. Therefore include the zmeas in the input parameters.

### Leap Second Management

When converting UTC to TDB ([different time standards explained](http://www.cv.nrao.edu/~rfisher/Ephemerides/times.html#TDB)), we need to inlcude for the leap second correction. We do not use Astropy for this correction due to the lack of an efficient mechanism to update the files when a new leap second is announced. Leap seconds are hard coded into Astropy’s ERFA routines, and thus to update for a new leap second the user would have to update Astropy and re-compile it. In this routine utc_tdb.py, we incorporate this is a stand alone file which is checked every time the code is run. Details for this can be found in the [wiki](https://github.com/shbhuk/barycorrpy/wiki).

### JDUTC to BJDTDB converter As explained in [Eastman et al. 2010](http://adsabs.harvard.edu/abs/2010PASP..122..935E), we also include a JDUTC to BJDTDB time converter.

We include the following corrections -

  1. Clock Correction - To correct for difference between UTC and TDB time scales.

  2. Geometric Correction - Light travel time from observatory to Solar System Barycenter.

  3. Einstein Correction - Relativistic correction since Earth is not an inertial frame.

The output of our function - utc_tdb.JDUTC_to_BJDTDB() matches the [web applet converter](http://astroutils.astronomy.ohio-state.edu/time/utc2bjd.html) to about 0.2ms . Therefore for applications requiring higher precision it should not be used. We advocate not using the standard Astropy converter this due to the same leap second staleness issue. Therefore for cases requiring such high precision, the leap second should be checked for and be updated as is done by this code.

### INSTALLATION INSTRUCTIONS

The instructions for installation and getting started for this package are detailed in the [wiki](https://github.com/shbhuk/barycorrpy/wiki).

## Citation To cite using this code you can cite this paper - [RNAAS](http://iopscience.iop.org/article/10.3847/2515-5172/aaa4b7).

Guidelines to cite this package can be found [here](https://github.com/AASJournals/Tutorials/blob/master/Repositories/CitingRepositories.md).

To sign up for updates, please join the Google Group linked here - https://groups.google.com/forum/#!forum/barycorrpy

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

barycorrpy-0.3.6.tar.gz (9.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

barycorrpy-0.3.6-py3-none-any.whl (10.0 MB view details)

Uploaded Python 3

File details

Details for the file barycorrpy-0.3.6.tar.gz.

File metadata

  • Download URL: barycorrpy-0.3.6.tar.gz
  • Upload date:
  • Size: 9.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.8.1

File hashes

Hashes for barycorrpy-0.3.6.tar.gz
Algorithm Hash digest
SHA256 154740b76288557199c12934bdd045628dd36130d83016ea46e0ad9093e66813
MD5 b99226c31b4a13001eead68c83d4aaf9
BLAKE2b-256 098a5571136c2477eda7bfbf10b69ed4abcbff49a4376317a30c904906b0d12d

See more details on using hashes here.

File details

Details for the file barycorrpy-0.3.6-py3-none-any.whl.

File metadata

  • Download URL: barycorrpy-0.3.6-py3-none-any.whl
  • Upload date:
  • Size: 10.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.8.1

File hashes

Hashes for barycorrpy-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e5d958b975b5b543677e5a68a119778ad1609088b9f7ff29d9d51cbc30c004b6
MD5 ddc96201758eef68f91d2bc38d6213a1
BLAKE2b-256 4b2a293c73f118a3cc92474fae42d52abeb3fb4c5f822a416e9c749b5f6495a7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page