# barycorrpy (v0.4.4)
### Please join the google group for updates regarding bug reports, new versions etc:
To sign up for updates, please join the Google Group linked here -
https://groups.google.com/g/barycorrpy
[](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.
### 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
Raw data
{
"_id": null,
"home_page": "https://github.com/shbhuk/barycorrpy",
"name": "barycorrpy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Barycentric Correction Astronomy Spectroscopy Radial Velocity",
"author": "Shubham Kanodia",
"author_email": "shbhuk@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/de/d8/4be808c608ea61312a59dd4c1f0385ec3cf104b45b39f8a6f7d38ae8054b/barycorrpy-0.4.4.tar.gz",
"platform": "",
"description": "# barycorrpy (v0.4.4)\n\n### Please join the google group for updates regarding bug reports, new versions etc:\nTo sign up for updates, please join the Google Group linked here -\nhttps://groups.google.com/g/barycorrpy\n\n[](https://doi.org/10.5281/zenodo.1115856)\n\n[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 .\nTo do this, it takes into consideration the following effects-\n\n1. Revolution of the Earth to consider position and velocity of the geocenter with respect to the Solar System barycenter\n2. Rotation of the Earth\n3. 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\n4. Gravitational time dilation due to objects of the Solar System\n5. Leap second offset\n6. Proper motion and systemic radial velocity of the star\n7. Parallax\n8. Shapiro delay\n\n\n\nThe installation instructions and the guide on how to run and use the code are explained in the [wiki](https://github.com/shbhuk/barycorrpy/wiki\n\nThere 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.\n\nIt 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.\n\n\n\n### JDUTC to BJDTDB converter\nAs explained in [Eastman et al. 2010](http://adsabs.harvard.edu/abs/2010PASP..122..935E), we also include a JDUTC to BJDTDB time converter.\n\nWe include the following corrections -\n\n1. Clock Correction - To correct for difference between UTC and TDB time scales.\n2. Geometric Correction - Light travel time from observatory to Solar System Barycenter.\n3. Einstein Correction - Relativistic correction since Earth is not an inertial frame.\n\nThe 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.\nWe 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.\n\n\n### INSTALLATION INSTRUCTIONS\n\nThe instructions for installation and getting started for this package are detailed in the [wiki](https://github.com/shbhuk/barycorrpy/wiki).\n\n## Citation\nTo cite using this code you can cite this paper - [RNAAS](http://iopscience.iop.org/article/10.3847/2515-5172/aaa4b7).\n\nGuidelines to cite this package can be found [here](https://github.com/AASJournals/Tutorials/blob/master/Repositories/CitingRepositories.md).\n\nTo sign up for updates, please join the Google Group linked here -\nhttps://groups.google.com/forum/#!forum/barycorrpy\n\n\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Barycentric Velocity correction at 1 cm/s level",
"version": "0.4.4",
"split_keywords": [
"barycentric",
"correction",
"astronomy",
"spectroscopy",
"radial",
"velocity"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "9a7cb7fc7c7e135523af2d21282d50a8",
"sha256": "fd4da983fb6b2c33c02298f93bbd30a18b916e65dbce69dd03760e492350b4c0"
},
"downloads": -1,
"filename": "barycorrpy-0.4.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a7cb7fc7c7e135523af2d21282d50a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9622538,
"upload_time": "2021-07-30T17:26:35",
"upload_time_iso_8601": "2021-07-30T17:26:35.482853Z",
"url": "https://files.pythonhosted.org/packages/94/2d/0d3f25c71d04eb687dda9d77be468b3c2c78aa12e0fc1a2db4672cb2f1df/barycorrpy-0.4.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "ad71be1483a29a2d13f4f1ed47ffc00f",
"sha256": "de6083a75b1ec9979dfe12c47b3b273bb2372ca9f426c5c8b8cda9aa3cd365c5"
},
"downloads": -1,
"filename": "barycorrpy-0.4.4.tar.gz",
"has_sig": false,
"md5_digest": "ad71be1483a29a2d13f4f1ed47ffc00f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9022983,
"upload_time": "2021-07-30T17:27:02",
"upload_time_iso_8601": "2021-07-30T17:27:02.825506Z",
"url": "https://files.pythonhosted.org/packages/de/d8/4be808c608ea61312a59dd4c1f0385ec3cf104b45b39f8a6f7d38ae8054b/barycorrpy-0.4.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-07-30 17:27:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "shbhuk",
"github_project": "barycorrpy",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "barycorrpy"
}
JSON
