Skip to main content

# barycorrpy

[![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

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

Metadata

Release files for barycorrpy 0.2.2.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 barycorrpy 0.2.2.1
File Size Uploaded Provenance Actions
barycorrpy-0.2.2.1.tar.gz 9.4 MB Without provenance Details for barycorrpy-0.2.2.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for barycorrpy 0.2.2.1
File Interpreter ABI Platform Actions
barycorrpy-0.2.2.1-py3-none-any.whl Python 3 none any Details for barycorrpy-0.2.2.1-py3-none-any.whl

Total release size: 19.4 MB

Release files / barycorrpy-0.2.2.1.tar.gz

Download URL barycorrpy-0.2.2.1.tar.gz
Size 9.4 MB
Tags Source
SHA-256 checksum
How to use checksums
33754678ea0252f9fb4a8988a17a59fe6c3fb3c7062ddae9424bbd3ec8c7807f
BLAKE2b-256 checksum
How to use checksums
6b6bf06ab7491dc2750da671af63d3cb8033291011358cb50937ec15ae317014
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.2

Release files / barycorrpy-0.2.2.1-py3-none-any.whl

Download URL barycorrpy-0.2.2.1-py3-none-any.whl
Size 10.0 MB
Tags Python 3
SHA-256 checksum
How to use checksums
5b631416bd4be3ff3c67d2c5b68d10d7c149d4d31308a2a7c0bf3cae4a5fa210
BLAKE2b-256 checksum
How to use checksums
3a09a18ad7abe04abdd97eab0f23287df85c911f39fc09d915f92c49a3e89c53
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.2

Security for barycorrpy 0.2.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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