kgeo

simple python analytic kerr raytracing

https://github.com/achael/kgeo

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: arxiv.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (6.1%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

simple python analytic kerr raytracing

Basic Info
  • Host: GitHub
  • Owner: achael
  • License: gpl-3.0
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage:
  • Size: 2.47 MB
Statistics
  • Stars: 19
  • Watchers: 3
  • Forks: 8
  • Open Issues: 3
  • Releases: 1
Created almost 5 years ago · Last pushed 11 months ago
Metadata Files
Readme License Citation

README.rst

This is a relatively simple implementation of raytracing null geodesics in the Kerr metric using the formalism of `Gralla and Lupsasca 2019 `_

In addition to some standard python libraries, this code requires the latest version of `scipy `_ to perform elliptic integrals of the third kind. 

Alternatively, elliptic integrals may be performed with bindings to GSL (which are much slower). To use GSL, you need to have the python ``ctypes`` module installed. Then verify that the following works:

.. code-block:: bash

  ctypes.CDLL('libgsl.so') 
  
Then modify the following global variables at the top of kgeo/kerr_raytracing_ana.py

.. code-block:: bash

  SCIPY = False
  GSL = True

To run a simple example, try

.. code-block:: bash

  from kgeo.kerr_raytracing_ana import *
  out = raytrace_ana(plotdata=True)

Citation (CITATION.cff)

cff-version: 1.0.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Chael"
  given-names: "Andrew"
  orcid: "https://orcid.org/0000-0003-2966-6220"
title: "kgeo"
version: 1.0.0
doi: 
date-released: 2022-06-07
url: "https://github.com/achael/kgeo"

GitHub Events

Total
  • Issues event: 1
  • Watch event: 6
  • Issue comment event: 1
  • Push event: 7
  • Pull request event: 2
  • Fork event: 2
Last Year
  • Issues event: 1
  • Watch event: 6
  • Issue comment event: 1
  • Push event: 7
  • Pull request event: 2
  • Fork event: 2

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 1
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 8 months
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 2.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: about 18 hours
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • catastropiyush (1)
Pull Request Authors
  • zgelles (3)
  • gnwong (3)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

setup.py pypi
  • ehtim *
  • h5py *
  • matplotlib *
  • mpmath *
  • numpy *
  • scipy *
  • tqdm *