{ "info": { "author": "Adam Batten", "author_email": "adamjbatten@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: BSD License", "Operating System :: MacOS", "Operating System :: Unix", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "|PyPI| |Python| |License| |Travis| |Docs| |CodeCov| |JOSS|\n\n|Logo|\n\n``Fruitbat`` is an open source python package used to estimate the redshift of \nFast Radio Bursts (FRB) from their dispersion measure. ``Fruitbat`` combines \nvarious dispersion measure (DM) and redshift relations with the YMW16 galactic \ndispersion measure model into a single easy to use API. \n\nDocumentation\n-------------\nThe documentation for ``fruitbat`` can be found at https://fruitbat.readthedocs.io/.\n\nInstallation\n------------\nYou can install the latest release of ``fruitbat`` from PyPi_ by running \nthe following::\n\n pip install fruitbat\n\nYou can install the latest development version of ``fruitbat`` by cloning \nthis repository::\n\n git clone https://github.com/abatten/fruitbat\n cd fruitbat\n pip install .\n\nIf you are installing the latest development version of ``fruitbat`` then you \nwill also need to install git-lfs. Instructions for installing git-lfs for\nyour operating system can be found here_.\n\nLinux Users\n***********\nIf you are installing ``fruitbat`` on a linux machine you may see this 'error':\n``ERROR: Failed building wheel for pyymw16``. This does not mean the installation\nfailed. The C++ bindings were compiled using MacOS and needed to be recompiled\nfor your machine. The installation process does this for you. You should still\nbe able to run ``fruitbat`` normally.\n\n.. _PyPi: https://pypi.python.org/pypi/fruitbat \n.. _here: https://help.github.com/en/articles/installing-git-large-file-storage\n\n\nRequirements\n------------\nBelow are the listed requirements for running ``fruitbat`` and the purpose for\neach requirement.\n\n - numpy: Array manipulation\n\n - scipy: Modules for integration and interpolation\n\n - astropy: Modules for cosmology, coordinates, constants and units\n\n - matplotlib: Modules for plotting\n\n - pandas: Reading csv files from FRBCAT\n\n - pyymw16: Python wrapper for YMW16 galactic dispersion measure model.\n\n - e13tools: Utility tools for writing docstrings.\n\nUsage\n-----\nIf you want to get started using ``fruitbat`` there is a `Getting Started`_ \nsection of the documentation made just for you! Otherwise the tl;dr is the\nfollowing:\n\nMost of the calculations will be centred around the `Frb class`_. You can\ncan define an instance of the `Frb class`_ with a dispersion measure. \nTo calculate the redshift of the FRB use the method \n`calc_redshift`_.\n\n::\n\n >>> import fruitbat\n >>> FRB121102 = fruitbat.Frb(557, dm_excess=369)\n >>> FRB121102.calc_redshift()\n \n\nThe `calc_redshift`_ function can also be passed a method and/or a cosmology.\nThe method will specify which DM-redshift relation to assume and the cosmology\nwill specify which cosmology to assume.\n\n::\n\n >>> FRB121102.calc_redshift(method=\"Zhang2018\", cosmology=\"Planck18\")\n \n\nIt is also possible to specify the coordinates of the burst and use the \n`calc_dm_galaxy`_ function to calculate the DM contribution from the Milky Way\nusing the YMW16 model. Performing `calc_dm_galaxy`_ will automatically\ncalculate the excess dispersion measure for the redshift calculation.\n\n::\n\n >>> FRB190222 = fruitbat.Frb(500, raj=\"12:34:43.5\", decj=\"2:34:15.2\")\n >>> FRB190222.calc_dm_galaxy()\n \n >>> FRB190222.calc_redshift()\n \n\n.. _Frb class: https://fruitbat.readthedocs.io/en/latest/api/fruitbat.Frb.html\n.. _calc_redshift: https://fruitbat.readthedocs.io/en/latest/api/fruitbat.Frb.html#fruitbat.Frb.calc_redshift\n.. _calc_dm_galaxy: https://fruitbat.readthedocs.io/en/latest/api/fruitbat.Frb.html#fruitbat.Frb.calc_dm_galaxy\n.. _Getting Started: https://fruitbat.readthedocs.io/en/latest/user_guide/getting_started\n\nIssues and Contributing\n-----------------------\nIf there is a feature of ``fruitbat`` that currently does not exist, but you\nwould like it to, you can contribute by openning a `Github Issue`_ and \noutlining the feature. Similar to contributing, if you find a problem with\n``fruitbat`` or are having difficulties using ``fruitbat`` please do not \nhesitate to open a `Github Issue`_.\n\n.. _Github Issue: https://github.com/abatten/fruitbat/issues\n\nReferencing Fruitbat\n--------------------\n\nIf you use ``fruitbat`` in your research, we would like it if you could\nreference `our paper`_.\n\n.. _our paper: https://ui.adsabs.harvard.edu/abs/2019JOSS....4.1399B/abstract\n\n::\n\n @ARTICLE{2019JOSS....4.1399B,\n author = {{Batten}, Adam},\n title = \"{Fruitbat: A Python Package for Estimating Redshifts of Fast Radio Bursts}\",\n journal = {The Journal of Open Source Software},\n keywords = {Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - High Energy Astrophysical Phenomena},\n year = \"2019\",\n month = \"May\",\n volume = {4},\n number = {37},\n pages = {1399},\n doi = {10.21105/joss.01399},\n archivePrefix = {arXiv},\n eprint = {1905.04294},\n primaryClass = {astro-ph.IM},\n adsurl = {https://ui.adsabs.harvard.edu/abs/2019JOSS....4.1399B},\n adsnote = {Provided by the SAO/NASA Astrophysics Data System}\n }\n\n\n\n\n.. |Logo| image:: logo/fruitbat_logo.svg\n :alt: Fruitbat Logo\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/fruitbat.svg?label=PyPI\n :target: https://pypi.python.org/pypi/fruitbat\n :alt: PyPI - Latest Release\n\n.. |Python| image:: https://img.shields.io/pypi/pyversions/fruitbat.svg?label=Python\n :target: https://pypi.python.org/pypi/fruitbat\n :alt: PyPI - Python Versions\n\n.. |Travis| image:: https://travis-ci.com/abatten/fruitbat.svg?branch=master\n :target: https://travis-ci.com/abatten/fruitbat\n\n.. |Docs| image:: https://readthedocs.org/projects/fruitbat/badge/?version=latest\n :target: https://fruitbat.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. |CodeCov| image:: https://codecov.io/gh/abatten/fruitbat/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/abatten/fruitbat\n :alt: Code Coverage\n\n.. |License| image:: https://img.shields.io/pypi/l/fruitbat.svg?colorB=purple&label=License\n :target: https://github.com/abatten/fruitbat/raw/master/LICENSE\n :alt: PyPI - License\n\n.. |JOSS| image:: http://joss.theoj.org/papers/634bb69f2445c7457bea5dbc0b83e650/status.svg\n :target: http://joss.theoj.org/papers/634bb69f2445c7457bea5dbc0b83e650\n :alt: JOSS Review Status\n\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "https://pypi.org/project/fruitbat", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/abatten/fruitbat", "keywords": "FRB redshift astronomy astrophysics fast radio burst", "license": "", "maintainer": "", "maintainer_email": "", "name": "fruitbat", "package_url": "https://pypi.org/project/fruitbat/", "platform": "", "project_url": "https://pypi.org/project/fruitbat/", "project_urls": { "Documentation": "https://fruitbat.readthedocs.io", "Download": "https://pypi.org/project/fruitbat", "Homepage": "https://github.com/abatten/fruitbat", "Source Code": "https://github.com/abatten/fruitbat" }, "release_url": "https://pypi.org/project/fruitbat/1.1.0/", "requires_dist": [ "numpy (>=1.12.0)", "scipy (>=1.0.0)", "astropy (>=2.0.0)", "matplotlib (>=2.2.4)", "pandas (>=0.22.0)", "pyymw16 (>=2.0.6)", "e13tools (>=0.5.3)" ], "requires_python": "", "summary": "Calculate the redshift of a FRB from its dispersion measure", "version": "1.1.0" }, "last_serial": 5670930, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "4e689bf1aa2cb40ef9ab008ac015e8bc", "sha256": "df892263fd9a619637f0fca0a3a433e83159a2931f44c88b80d1df98df112df9" }, "downloads": -1, "filename": "fruitbat-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "4e689bf1aa2cb40ef9ab008ac015e8bc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2505, "upload_time": "2019-02-11T07:34:20", "url": "https://files.pythonhosted.org/packages/0f/74/d73450af10e148552dc23624156c8d63d1a73ab3378c82580953ce6fef79/fruitbat-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4c084c3121c332a86ebd1d8d059f2549", "sha256": "e509f2cc8048a8035ee4dbd32d9ef3fd5a5f8ae8e694a5dbd578c20bc43330c4" }, "downloads": -1, "filename": "fruitbat-0.0.1.tar.gz", "has_sig": false, "md5_digest": "4c084c3121c332a86ebd1d8d059f2549", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2375, "upload_time": "2019-02-11T07:34:23", "url": "https://files.pythonhosted.org/packages/61/02/d2f96cedbd2cc9f9154bb20d1d260060a2cce58c3322ae303cff39668925/fruitbat-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "a3f610c14a44b99bed5871452ad894f4", "sha256": "cede4ecc66c2f54c7c34d18d14960acee2cbf0c04c9a6a650cddf82eca46557d" }, "downloads": -1, "filename": "fruitbat-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "a3f610c14a44b99bed5871452ad894f4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 13276, "upload_time": "2019-02-20T10:59:29", "url": "https://files.pythonhosted.org/packages/76/e3/32353a00c6eced2ce46e9aef99cc435835d48b808f5746e7e43f6318731c/fruitbat-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e215857f2f9435866a2380c89b721ede", "sha256": "936c03c976eb9c980f35ba9e6113868e1762900575ba5aae060c8ea43a968ce7" }, "downloads": -1, "filename": "fruitbat-0.0.2.tar.gz", "has_sig": false, "md5_digest": "e215857f2f9435866a2380c89b721ede", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12247, "upload_time": "2019-02-20T10:59:31", "url": "https://files.pythonhosted.org/packages/2e/c2/4aca7f8996479e783d978c9be70c56140fce8910b056f1e3d1b740bda65e/fruitbat-0.0.2.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "89e99bb700d3fafe44c797f9bb8b4d7a", "sha256": "125630da5c5842496fb7a90fd5af86fc5de53f6d78eb1d8cbd1227877c38f893" }, "downloads": -1, "filename": "fruitbat-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "89e99bb700d3fafe44c797f9bb8b4d7a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2575602, "upload_time": "2019-04-11T00:42:31", "url": "https://files.pythonhosted.org/packages/e7/5b/84f05c9b15b94c97c6abcaae68bd86b31e440e2421491aa203daf7b21c37/fruitbat-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3d5861aae27c3785182b96755250e165", "sha256": "f4f48d520340b1732aa8b8058738300b92f03f7715c81f29e861990100caaa3b" }, "downloads": -1, "filename": "fruitbat-1.0.0.tar.gz", "has_sig": false, "md5_digest": "3d5861aae27c3785182b96755250e165", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2574356, "upload_time": "2019-04-11T00:43:43", "url": "https://files.pythonhosted.org/packages/c7/09/a65aec036d40775cc9039f8e5132ed7d97dda1624db82c762b85a0f635c0/fruitbat-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "829825604ba7dc9a9497abb67a370425", "sha256": "375882c70d452ddd45aa84e720d2fec63e45445d4debb49a42a41e43d4fc1ec5" }, "downloads": -1, "filename": "fruitbat-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "829825604ba7dc9a9497abb67a370425", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2575598, "upload_time": "2019-05-05T09:50:32", "url": "https://files.pythonhosted.org/packages/89/34/0c56004abd11dc82e210893b2b2f2663396bda05e0a92d1fa9035f2a7508/fruitbat-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e175df6f0eca672ab7710457e6561dd2", "sha256": "aabc90b8966d01a6b865b209ee7bc54639e19cac77ac9fdd0afcd4bfe81c42ad" }, "downloads": -1, "filename": "fruitbat-1.0.1.tar.gz", "has_sig": false, "md5_digest": "e175df6f0eca672ab7710457e6561dd2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2574412, "upload_time": "2019-05-05T09:50:35", "url": "https://files.pythonhosted.org/packages/f8/e8/6d67b0cb6f72cf6bfdc598e55ee1253b03943493d9faf8f81082d9b05d72/fruitbat-1.0.1.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "2aeda420fbbea12916d0be754ee62a22", "sha256": "d2b97866df5b872da2f4d3072b7ff8524cdaf65aaad6ad7530c8151be2216257" }, "downloads": -1, "filename": "fruitbat-1.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "2aeda420fbbea12916d0be754ee62a22", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2569852, "upload_time": "2019-08-13T09:23:41", "url": "https://files.pythonhosted.org/packages/76/4a/d7ee13e9689d92139196b50d26da50cd60f195cc33d408b372d1f8126a9c/fruitbat-1.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4feed60446c0f02d9b00869920408e45", "sha256": "9290d3a24252e9d310a01a0b2a83996037ed6a03f2f006167c76bc4366c01b49" }, "downloads": -1, "filename": "fruitbat-1.1.0.tar.gz", "has_sig": false, "md5_digest": "4feed60446c0f02d9b00869920408e45", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2574652, "upload_time": "2019-08-13T09:23:44", "url": "https://files.pythonhosted.org/packages/da/e1/f1ba62719da6165d0f606721350175df1cb19e26a21fd8cf96ff0c80a892/fruitbat-1.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "2aeda420fbbea12916d0be754ee62a22", "sha256": "d2b97866df5b872da2f4d3072b7ff8524cdaf65aaad6ad7530c8151be2216257" }, "downloads": -1, "filename": "fruitbat-1.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "2aeda420fbbea12916d0be754ee62a22", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2569852, "upload_time": "2019-08-13T09:23:41", "url": "https://files.pythonhosted.org/packages/76/4a/d7ee13e9689d92139196b50d26da50cd60f195cc33d408b372d1f8126a9c/fruitbat-1.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4feed60446c0f02d9b00869920408e45", "sha256": "9290d3a24252e9d310a01a0b2a83996037ed6a03f2f006167c76bc4366c01b49" }, "downloads": -1, "filename": "fruitbat-1.1.0.tar.gz", "has_sig": false, "md5_digest": "4feed60446c0f02d9b00869920408e45", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2574652, "upload_time": "2019-08-13T09:23:44", "url": "https://files.pythonhosted.org/packages/da/e1/f1ba62719da6165d0f606721350175df1cb19e26a21fd8cf96ff0c80a892/fruitbat-1.1.0.tar.gz" } ] }