{
    "info": {
        "author": "Eric Gourgoulhon, Alexandre Le Tiec, Frederic Vincent, Niels Warburton",
        "author_email": "eric.gourgoulhon@obspm.fr",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Intended Audience :: Science/Research",
            "License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Topic :: Scientific/Engineering :: Astronomy",
            "Topic :: Scientific/Engineering :: Mathematics",
            "Topic :: Scientific/Engineering :: Physics"
        ],
        "description": "# kerrgeodesic_gw\n\nA [SageMath](http://www.sagemath.org/) package to compute gravitational radiation from material orbiting a Kerr black hole\n\nThis package makes use of SageMath functionalities developed through the [SageManifolds](https://sagemanifolds.obspm.fr/) project and is part of the [Black Hole Peturbation Toolkit](http://bhptoolkit.org/).\n\n## Installation\n\n### Requirements\n\nThis package requires the Python-based free mathematics software system [SageMath](http://www.sagemath.org/) (at least version 8.2).\n\n*NB:* the version of SageMath shipped with Ubuntu 18.04 is only 8.1; instead of\nthe Ubuntu package `sagemath`, install then the most recent binary for Ubuntu 18.04\nfrom [SageMath download page](http://www.sagemath.org/download-linux.html).\n\n### Simple installation from PyPI\n\nIt suffices to run\n\n    sage -pip install kerrgeodesic_gw\n\nto have the package ready to use in SageMath.\nSee however *install from source* below if you want to build a\nlocal version of the documentation or modify the source files (development).\n\n*NB:* on the [CoCalc](https://cocalc.com) cloud computing platform, you need\nto add the option `--user`, i.e. open a terminal and run\n\n    sage -pip install --user kerrgeodesic_gw\n\n\nHere is the [kerrgeodesic_gw page](https://pypi.org/project/kerrgeodesic-gw/) on PyPI (the Python Package Index).\n\n### Install from source\n\nDownload the source from the git repository:\n\n    git clone https://github.com/BlackHolePerturbationToolkit/kerrgeodesic_gw.git\n\nThis creates a directory `kerrgeodesic_gw`.\n\nRun\n\n    sage -pip install --upgrade --no-index -v kerrgeodesic_gw\n\nto install the package in SageMath.\nA shortcut of the above command is provided by the `Makefile` distributed with the package:\n\n    cd kerrgeodesic_gw\n    make install\n\n*NB:* on [CoCalc](https://cocalc.com), you need to add the option `--user`, i.e. open a terminal and run\n\n    git clone https://github.com/BlackHolePerturbationToolkit/kerrgeodesic_gw.git\n    sage -pip install --user --upgrade --no-index -v kerrgeodesic_gw\n\n#### Install for development\n\nIf you plan to edit the package source, you should add the option `-e` to the pip install, i.e. run\n\n    sage -pip install --upgrade --no-index -v -e kerrgeodesic_gw\n\nor equivalently\n\n    cd kerrgeodesic_gw\n    make develop\n\n## Usage\n\nOnce the package is installed, you can use it in SageMath, like for instance:\n\n    sage: from kerrgeodesic_gw import spin_weighted_spherical_harmonic\n    sage: theta, phi = var('theta phi')\n    sage: spin_weighted_spherical_harmonic(-2, 2, 1, theta, phi)\n    1/4*(sqrt(5)*cos(theta) + sqrt(5))*e^(I*phi)*sin(theta)/sqrt(pi)\n\n\n## Tests\n\nThis package is configured for tests written in the documentation strings of the source files, also known as *doctests*.\nYou may then test the install by running, from the root of the package tree\n(i.e. the directory kerrgeodesic_gw created by the `git clone`),\n\n    sage -t kerrgeodesic_gw\n\nYou should then get the message `All tests passed!`\n\nAlternatively, you can run (from the same directory)\n\n    make test\n\n\n## Documentation\n\nThe package documentation can be generated using SageMath's [Sphinx](http://www.sphinx-doc.org/) installation:\n\n    cd docs\n    sage -sh -c \"make html\"\n\nA shorthand of the above is\n\n    make doc\n\nThe html reference manual is then at\n\n    kerrgeodesic_gw/docs/build/html/index.html\n\nFor the LaTeX documentation, use\n\n    make doc-pdf\n\nThe pdf reference manual is then\n\n    kerrgeodesic_gw/docs/build/latex/kerrgeodesic_gw.pdf\n\n### Online documentation\n\n- [Reference manual](https://share.cocalc.com/share/2b3f8da9-6d53-4261-b5a5-ff27b5450abb/kerrgeodesic_gw/docs/build/html/index.html)\n  ([PDF](https://cocalc.com/share/2b3f8da9-6d53-4261-b5a5-ff27b5450abb/kerrgeodesic_gw/docs/build/latex/kerrgeodesic_gw.pdf))\n- [Article describing the formulas implemented in the package](https://doi.org/10.1051/0004-6361/201935406) *(open access)*\n- Demo notebooks:\n\n  - [Spin-weighted spheroidal harmonics](https://nbviewer.jupyter.org/github/BlackHolePerturbationToolkit/kerrgeodesic_gw/blob/master/Notebooks/basic_kerrgeodesic_gw.ipynb) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/BlackHolePerturbationToolkit/kerrgeodesic_gw/master?filepath=Notebooks/basic_kerrgeodesic_gw.ipynb)\n  - [Timelike geodesic in Kerr spacetime](https://nbviewer.jupyter.org/github/BlackHolePerturbationToolkit/kerrgeodesic_gw/blob/master/Notebooks/geod_Kerr.ipynb) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/BlackHolePerturbationToolkit/kerrgeodesic_gw/master?filepath=Notebooks/geod_Kerr.ipynb)\n  - [Gravitational waves from circular orbits around a Kerr black hole](https://nbviewer.jupyter.org/github/BlackHolePerturbationToolkit/kerrgeodesic_gw/blob/master/Notebooks/grav_waves_circular.ipynb) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/BlackHolePerturbationToolkit/kerrgeodesic_gw/master?filepath=Notebooks/grav_waves_circular.ipynb)\n  - [More on gravitational waves from circular orbits](https://share.cocalc.com/share/2b3f8da9-6d53-4261-b5a5-ff27b5450abb/gw_single_particle.ipynb?viewer=share)\n\n- For the tensor calculus functionalities of the\n  [KerrBH](https://share.cocalc.com/share/2b3f8da9-6d53-4261-b5a5-ff27b5450abb/kerrgeodesic_gw/docs/build/html/kerr_spacetime.html)\n  class provided by the package, see these examples:\n  [Kerr 1](https://nbviewer.jupyter.org/github/sagemanifolds/SageManifolds/blob/master/Worksheets/v1.3/SM_Kerr.ipynb),\n  [Kerr 2](https://nbviewer.jupyter.org/github/sagemanifolds/SageManifolds/blob/master/Worksheets/v1.3/SM_Kerr_Killing_tensor.ipynb),\n  [Kerr 3](https://nbviewer.jupyter.org/github/sagemanifolds/SageManifolds/blob/master/Worksheets/v1.3/SM_Simon-Mars_Kerr.ipynb),\n  and more generally [SageManifolds documentation](https://sagemanifolds.obspm.fr/documentation.html).\n\n\n## Authors\n\n- Eric Gourgoulhon\n- Alexandre Le Tiec\n- Frederic Vincent\n- Niels Warburton\n\n**Reference:** E. Gourgoulhon, A. Le Tiec, F. H. Vincent & N. Warburton: *Gravitational waves from bodies orbiting the Galactic center black hole and their detectability by LISA*, [A&A **627**, A92 (2019)](https://doi.org/10.1051/0004-6361/201935406) (preprint: [arXiv:1903.02049](https://arxiv.org/abs/1903.02049))\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/BlackHolePerturbationToolkit/kerrgeodesic_gw",
        "keywords": "SageMath",
        "license": "GPLv2+",
        "maintainer": "",
        "maintainer_email": "",
        "name": "kerrgeodesic-gw",
        "package_url": "https://pypi.org/project/kerrgeodesic-gw/",
        "platform": "",
        "project_url": "https://pypi.org/project/kerrgeodesic-gw/",
        "project_urls": {
            "Homepage": "https://github.com/BlackHolePerturbationToolkit/kerrgeodesic_gw"
        },
        "release_url": "https://pypi.org/project/kerrgeodesic-gw/0.2.2/",
        "requires_dist": [
            "sphinx"
        ],
        "requires_python": "",
        "summary": "Gravitational radiation from material orbiting a Kerr black hole",
        "version": "0.2.2"
    },
    "last_serial": 5588125,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c78cde00bb41ebbcd4c0da0bb74e67cf",
                    "sha256": "4beae72018da531ed7be47005e2e52d6d393d5bce4e57a07a4673b80401828e4"
                },
                "downloads": -1,
                "filename": "kerrgeodesic_gw-0.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c78cde00bb41ebbcd4c0da0bb74e67cf",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 731528,
                "upload_time": "2019-02-07T15:57:17",
                "url": "https://files.pythonhosted.org/packages/b4/2b/4d8f6f23d28e3abba309d9740f60fca136f1774b453f7e669fd533531439/kerrgeodesic_gw-0.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "fc17a832689499c13704fb9dc2542721",
                    "sha256": "63643f53c0f671f10f08c2dbab19ec8d821f47cfd6c1f79a5c09080d577c6b88"
                },
                "downloads": -1,
                "filename": "kerrgeodesic_gw-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "fc17a832689499c13704fb9dc2542721",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 708032,
                "upload_time": "2019-02-07T15:57:20",
                "url": "https://files.pythonhosted.org/packages/18/66/12696b7a107a8fbf5b3966bbe733c783c180a7472dc507f52f7c535807aa/kerrgeodesic_gw-0.1.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0f3e5d878917f0771234dafc37e09713",
                    "sha256": "be48c5ce66019c02326b53e83f37c2fe17060ee069f2c0652212ec1e06617c41"
                },
                "downloads": -1,
                "filename": "kerrgeodesic_gw-0.1.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "0f3e5d878917f0771234dafc37e09713",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 732116,
                "upload_time": "2019-02-22T15:59:30",
                "url": "https://files.pythonhosted.org/packages/c7/9a/1c0132398bf72949578ee04c6f7ed14e466c189dea0a57324c2a5faffc67/kerrgeodesic_gw-0.1.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "d77af6c1477cecb1fe7b3c2c65f29770",
                    "sha256": "060919a0164de10f4fea8df1e0af06435138821eddcacd472cc176ff50f90a36"
                },
                "downloads": -1,
                "filename": "kerrgeodesic_gw-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "d77af6c1477cecb1fe7b3c2c65f29770",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 709114,
                "upload_time": "2019-02-22T15:59:32",
                "url": "https://files.pythonhosted.org/packages/f0/9f/d3f1a1fcc3913fa27f36a0147e008e0fca83fd1fa29e3f2b4ebfefdef8ca/kerrgeodesic_gw-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "98b505aa92a1ff16678206453e9a6875",
                    "sha256": "3b31fa9de0258014595dd42d20e550cd4932a79e02bc8e3a1ede2ab18d78a852"
                },
                "downloads": -1,
                "filename": "kerrgeodesic_gw-0.1.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "98b505aa92a1ff16678206453e9a6875",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 732277,
                "upload_time": "2019-03-07T10:54:31",
                "url": "https://files.pythonhosted.org/packages/55/76/7eeb43cc8283082dc0a4e3ff0c2dd52791d69db5254fbfd46c160775378b/kerrgeodesic_gw-0.1.2-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "be3c6adf66041d0928afc26bf914367d",
                    "sha256": "b9c03c38da437d60cf202898dd3890433c5f110496c5000275947b1d26605edf"
                },
                "downloads": -1,
                "filename": "kerrgeodesic_gw-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "be3c6adf66041d0928afc26bf914367d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 709805,
                "upload_time": "2019-03-07T10:54:39",
                "url": "https://files.pythonhosted.org/packages/27/31/6d4ef3cca57ed1f5402862d61592ff247f53a3c5242f59a70783d682a823/kerrgeodesic_gw-0.1.2.tar.gz"
            }
        ],
        "0.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3f0fb43c01fb22ed4060b3b9451a3d05",
                    "sha256": "3d580766303ab62b97f29e09f84fa1a0e960f4cf44b73e5381db1e3aaefdb0dc"
                },
                "downloads": -1,
                "filename": "kerrgeodesic_gw-0.1.3-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "3f0fb43c01fb22ed4060b3b9451a3d05",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 732270,
                "upload_time": "2019-03-17T16:56:45",
                "url": "https://files.pythonhosted.org/packages/f3/c6/93a42caa54d911e9e8e28c6cf362a6e4a3895363826a08428df5edbacf34/kerrgeodesic_gw-0.1.3-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "14c93e3183a0de53af5045178d2fd61e",
                    "sha256": "54b263ff08de1d16d792deb50f511694e9143fbd484fb30d76bc16abb55f2b0f"
                },
                "downloads": -1,
                "filename": "kerrgeodesic_gw-0.1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "14c93e3183a0de53af5045178d2fd61e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 709803,
                "upload_time": "2019-03-17T16:56:54",
                "url": "https://files.pythonhosted.org/packages/d0/39/ab83d6231fa78ef9602423962f8d631ffa6af7aa674b98d9ee236c338f78/kerrgeodesic_gw-0.1.3.tar.gz"
            }
        ],
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "11adca42d0ed20e6f5bdfda4536c1e2f",
                    "sha256": "33031a6eca4eda8126bce5660b12ed6b36334a5e4bab595807980f5f39477c65"
                },
                "downloads": -1,
                "filename": "kerrgeodesic_gw-0.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "11adca42d0ed20e6f5bdfda4536c1e2f",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 734760,
                "upload_time": "2019-05-19T19:28:59",
                "url": "https://files.pythonhosted.org/packages/97/90/6efade4ef6ff0f540e93141b9da065f9f549c9055cada89075fb4ace7c34/kerrgeodesic_gw-0.2-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "8d3bc96c6f7dc8f00568c27f6fc94602",
                    "sha256": "bf6305b112c609777107d71adf64e2bf5245deb8231e9e024a1f365d3ec5270f"
                },
                "downloads": -1,
                "filename": "kerrgeodesic_gw-0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "8d3bc96c6f7dc8f00568c27f6fc94602",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 711934,
                "upload_time": "2019-05-19T19:29:08",
                "url": "https://files.pythonhosted.org/packages/31/c9/38b5045d0349ec023292f02ca1c97ab3f1578ad796b9b692f503c4e98891/kerrgeodesic_gw-0.2.tar.gz"
            }
        ],
        "0.2.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "434bee578c2cf1370b7d83acb69d75a7",
                    "sha256": "1e31128dd26e151bb18cb0fe61d6f7116ea448417bcb898b72e5361ac12ff0fc"
                },
                "downloads": -1,
                "filename": "kerrgeodesic_gw-0.2.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "434bee578c2cf1370b7d83acb69d75a7",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 734980,
                "upload_time": "2019-07-06T20:49:28",
                "url": "https://files.pythonhosted.org/packages/31/5e/6fe9ff8753112285f180dc81217707e1c7b7d98ced6bf6debc8c0eee3799/kerrgeodesic_gw-0.2.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "40c9bf6ca3b93b8b88de21e0f7e12c4f",
                    "sha256": "4c825e0292ab62a21eebe75ccbf7e5b35bb154f12c6620e026901c43bad4668c"
                },
                "downloads": -1,
                "filename": "kerrgeodesic_gw-0.2.1.tar.gz",
                "has_sig": false,
                "md5_digest": "40c9bf6ca3b93b8b88de21e0f7e12c4f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 712200,
                "upload_time": "2019-07-06T20:49:38",
                "url": "https://files.pythonhosted.org/packages/8a/ca/dce4cb1b2f9ebf8aab6e472f34b7da8d13beda1db072ccbdcaf08a0db459/kerrgeodesic_gw-0.2.1.tar.gz"
            }
        ],
        "0.2.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "70b1371137319489c6fac9cb5921f6ba",
                    "sha256": "03a0394778840145890994cf658e5205ec7ecad7757cd37e076e724ffe9686d9"
                },
                "downloads": -1,
                "filename": "kerrgeodesic_gw-0.2.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "70b1371137319489c6fac9cb5921f6ba",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 735339,
                "upload_time": "2019-07-26T09:45:16",
                "url": "https://files.pythonhosted.org/packages/3c/ba/14d1b7becdf32989391acea306b1a3db0ca58ec60e85806b7e35a26432c0/kerrgeodesic_gw-0.2.2-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "139b92a34b1b961e4b1bac52dcb711cb",
                    "sha256": "05d50a8e44ad44b0d8a2823137eaa8323023bd29078c531107a50d5ec64d96ba"
                },
                "downloads": -1,
                "filename": "kerrgeodesic_gw-0.2.2.tar.gz",
                "has_sig": false,
                "md5_digest": "139b92a34b1b961e4b1bac52dcb711cb",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 712476,
                "upload_time": "2019-07-26T09:45:25",
                "url": "https://files.pythonhosted.org/packages/ad/d5/5f6793ce0b947ee558c9f1ca8335b977c134b2de8f013e1a7fcb7ce10613/kerrgeodesic_gw-0.2.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "70b1371137319489c6fac9cb5921f6ba",
                "sha256": "03a0394778840145890994cf658e5205ec7ecad7757cd37e076e724ffe9686d9"
            },
            "downloads": -1,
            "filename": "kerrgeodesic_gw-0.2.2-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "70b1371137319489c6fac9cb5921f6ba",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 735339,
            "upload_time": "2019-07-26T09:45:16",
            "url": "https://files.pythonhosted.org/packages/3c/ba/14d1b7becdf32989391acea306b1a3db0ca58ec60e85806b7e35a26432c0/kerrgeodesic_gw-0.2.2-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "139b92a34b1b961e4b1bac52dcb711cb",
                "sha256": "05d50a8e44ad44b0d8a2823137eaa8323023bd29078c531107a50d5ec64d96ba"
            },
            "downloads": -1,
            "filename": "kerrgeodesic_gw-0.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "139b92a34b1b961e4b1bac52dcb711cb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 712476,
            "upload_time": "2019-07-26T09:45:25",
            "url": "https://files.pythonhosted.org/packages/ad/d5/5f6793ce0b947ee558c9f1ca8335b977c134b2de8f013e1a7fcb7ce10613/kerrgeodesic_gw-0.2.2.tar.gz"
        }
    ]
}