kerrz-python 0.1.0__tar.gz → 0.2.0__tar.gz

{kerrz_python-0.1.0 → kerrz_python-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kerrz_python
-Version: 0.1.0
+Version: 0.2.0
 Summary: Python wrapper for kerrz. Avoid installing directly, use kerrz[py] unless you know what you are doing.
 Home-page: https://codeberg.org/astro-group/kerrz-py
 Author: Fergus Baker
@@ -13,7 +13,7 @@ Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
-Requires-Dist: kerrz_lib>=0.1.15
+Requires-Dist: kerrz_lib>=0.2.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

kerrz_python-0.2.0/kerrz_python/VERSION

@@ -0,0 +1 @@
+0.2.0

kerrz_python-0.2.0/kerrz_python/__init__.py

@@ -0,0 +1,5 @@
+import kerrz_python.wrappers
+from kerrz_python.wrappers import *
+
+__all__ = []
+__all__.extend(kerrz_python.wrappers.__all__)

kerrz_python-0.2.0/kerrz_python/wrappers.py

@@ -0,0 +1,171 @@
+# This file contains wrapper code that directly calls the bindings.
+import ctypes
+import math
+import enum
+
+import kerrz_lib.bindings as bindings
+
+__all__ = ["Status", "FourVector", "KerrMetric", "TraceResult", "NullGeodesic"]
+
+PROTECTED_ATTRIBUTE_NAMES = {"lambda": "lambda_"}
+
+REVERSE_ATTRIBUTE_NAMES = {v: k for (k, v) in PROTECTED_ATTRIBUTE_NAMES.items()}
+
+
+class Status(enum.Enum):
+    NONE = 0
+    EVENT_HORIZON = 1
+    INTERSECTED_DISC = 2
+    AT_INFINITY = 3
+
+
+def _reverse_protected_name(name: str) -> str:
+    """The opposite of _protected_name."""
+    return REVERSE_ATTRIBUTE_NAMES.get(name, name)
+
+
+def _protected_name(name: str) -> str:
+    """Turns strings that are also Python keywords into things that are not."""
+    return PROTECTED_ATTRIBUTE_NAMES.get(name, name)
+
+
+class AttributeExtender:
+
+    def __init__(self, backed_type):
+        self._backing_type = backed_type
+
+    def __getattr__(self, name):
+        this_attributes = object.__dir__(self)
+        if name in this_attributes:
+            return __getattribute__(self, name)
+
+        # Protected names
+        return getattr(self._backing_type, _reverse_protected_name(name))
+
+    def __dir__(self):
+        this_attributes = object.__dir__(self)
+        # Expose all of the public C bindings
+        return this_attributes + [
+            _protected_name(i) for i in dir(self._backing_type) if not i.startswith("_")
+        ]
+
+
+class FourVector:
+
+    def __init__(self, t=0, r=1, theta=math.pi / 2.0, phi=0):
+        """Construct a new four-vector in the Boyer-Lindquist coordinates."""
+        self._vec = bindings.krz_FourVector(t=t, r=r, th=theta, ph=phi)
+
+    def __repr__(self) -> str:
+        return f"FourVector(t={self.t},r={self.r},theta={self.theta},phi={self.phi})"
+
+    def __eq__(self, other: "FourVector") -> str:
+        return (
+            self.t == other.t
+            and self.r == other.r
+            and self.theta == other.theta
+            and self.phi == other.phi
+        )
+
+    @property
+    def t(self):
+        return self._vec.t
+
+    @t.setter
+    def t(self, value: float):
+        self._vec.t = value
+
+    @property
+    def r(self):
+        return self._vec.r
+
+    @r.setter
+    def r(self, value: float):
+        self._vec.r = value
+
+    @property
+    def theta(self):
+        return self._vec.th
+
+    @theta.setter
+    def theta(self, value: float):
+        self._vec.th = value
+
+    @property
+    def phi(self):
+        return self._vec.ph
+
+    @phi.setter
+    def phi(self, value: float):
+        self._vec.ph = value
+
+
+class KerrMetric(AttributeExtender):
+
+    def __init__(self, M: float = 1, a: float = 0.998):
+        self._metric = bindings.krz_kerrMetric(M, a)
+        super().__init__(self._metric)
+
+    def __repr__(self) -> str:
+        return f"KerrMetric(M={self.M},a={self.a})"
+
+
+class TraceResult(AttributeExtender):
+
+    def __init__(self, result: bindings.krz_TraceResult):
+        self._result = result
+        super().__init__(self._result)
+
+    def __getattr__(self, name: str):
+        if name == "status":
+            return Status(self._result.status)
+        return super().__getattr__(name)
+
+    def to_xyz(self) -> tuple[float, float, float]:
+        x = self.r * math.sin(self.theta) * math.cos(self.phi)
+        y = self.r * math.sin(self.theta) * math.sin(self.phi)
+        z = self.r * math.cos(self.theta)
+        return (x, y, z)
+
+
+class NullGeodesic(AttributeExtender):
+
+    def __init__(
+        self,
+        metric: KerrMetric,
+        x_init: FourVector = FourVector(r=1e4, theta=0.2),
+        alpha=1.0,
+        beta=2.0,
+    ):
+        self.x_init = x_init
+        self.metric = metric
+        self.alpha = alpha
+        self.beta = beta
+
+        # Private attributes
+        self._path_builder = None
+        self._initial_conditions = bindings.krz_InitialConditions()
+        bindings.krz_fromImpactParameters(
+            ctypes.byref(self._initial_conditions),
+            self.metric._metric,
+            self.x_init._vec,
+            self.alpha,
+            self.beta,
+        )
+
+        super().__init__(self._initial_conditions)
+
+    def _get_pathbuilder(self):
+        if self._path_builder is None:
+            pb = bindings.krz_PathBuilder()
+            bindings.krz_PathBuilder_init(
+                ctypes.byref(pb), self.metric._metric, self._initial_conditions
+            )
+            self._path_builder = pb
+        return self._path_builder
+
+    def at_mino_time(self, mino_time: float) -> TraceResult:
+        result = bindings.krz_at_mino_time(
+            ctypes.byref(self._get_pathbuilder()), mino_time
+        )
+        return TraceResult(result)

{kerrz_python-0.1.0 → kerrz_python-0.2.0}/kerrz_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kerrz_python
-Version: 0.1.0
+Version: 0.2.0
 Summary: Python wrapper for kerrz. Avoid installing directly, use kerrz[py] unless you know what you are doing.
 Home-page: https://codeberg.org/astro-group/kerrz-py
 Author: Fergus Baker
@@ -13,7 +13,7 @@ Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
-Requires-Dist: kerrz_lib>=0.1.15
+Requires-Dist: kerrz_lib>=0.2.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{kerrz_python-0.1.0 → kerrz_python-0.2.0}/kerrz_python.egg-info/SOURCES.txt

@@ -3,8 +3,10 @@ pyproject.toml
 setup.py
 kerrz_python/VERSION
 kerrz_python/__init__.py
+kerrz_python/wrappers.py
 kerrz_python.egg-info/PKG-INFO
 kerrz_python.egg-info/SOURCES.txt
 kerrz_python.egg-info/dependency_links.txt
 kerrz_python.egg-info/requires.txt
-kerrz_python.egg-info/top_level.txt
+kerrz_python.egg-info/top_level.txt
+test/test_basics.py

kerrz_python-0.2.0/kerrz_python.egg-info/requires.txt

@@ -0,0 +1 @@
+kerrz_lib>=0.2.0

{kerrz_python-0.1.0 → kerrz_python-0.2.0}/setup.py

@@ -15,7 +15,7 @@ setup(
     long_description=readme,
     long_description_content_type="text/markdown",
     python_requires=">=3.6",
-    install_requires=["kerrz_lib>=0.1.15"],
+    install_requires=["kerrz_lib>=0.2.0"],
     license="GPL-3.0-or-later",
     name=package_name,
     version=version,
@@ -31,5 +31,6 @@ setup(
         "Programming Language :: Python :: 3",
     ],
     include_package_data=True,
+    extas_require={"test": ["numpy", "pytest"]},
     package_data={package_name: ["VERSION"]},
 )

kerrz_python-0.2.0/test/test_basics.py

@@ -0,0 +1,24 @@
+import kerrz_python as kpy
+import numpy as np
+import matplotlib.pyplot as plt
+
+
+def test_path_construction():
+    metric = kpy.KerrMetric(a=0.998)
+    x_init = kpy.FourVector(r=1e2)
+
+    geod = kpy.NullGeodesic(metric, x_init, beta=1e-3, alpha=6.5)
+
+    times = np.linspace(0.0, 0.75, 32)
+    path = [geod.at_mino_time(t).to_xyz() for t in times]
+
+    assert path[0] == (
+        100.00000000000271,
+        0.0,
+        6.1232339957369325e-15,
+    )
+    assert path[-1] == (
+        -0.8615892868245583,
+        0.6429150669138306,
+        0.0001664544488992621,
+    )

kerrz_python-0.1.0/kerrz_python/VERSION

@@ -1 +0,0 @@
-0.1.0

kerrz_python-0.1.0/kerrz_python/__init__.py

@@ -1,68 +0,0 @@
-import dataclasses
-import ctypes
-import enum
-import kerrz_lib.bindings as bindings
-
-
-class Status(enum.Enum):
-    NONE = 0
-    EVENT_HORIZON = 1
-    INTERSECTED_DISC = 2
-    AT_INFINITY = 3
-
-
-@dataclasses.dataclass
-class GeodesicPoint:
-    status: Status
-    t: float
-    r: float
-    theta: float
-    phi: float
-    winding: int
-
-
-@dataclasses.dataclass
-class TurningPoints:
-    r_0: float
-    r_1: float
-    theta_0: float
-    theta_1: float
-
-
-class NullGeodesic:
-
-    def __init__(self, path_builder: bindings.krz_PathBuilder):
-        self._path_builder = path_builder
-
-    def at_mino_time(self, mino_time) -> GeodesicPoint:
-        result = bindings.krz_at_mino_time(ctypes.byref(self._path_builder), mino_time)
-        return GeodesicPoint(
-            status=result.status,
-            t=result.t,
-            r=result.r,
-            theta=result.theta,
-            phi=result.phi,
-            winding=int(result.winding),
-        )
-
-    def turning_points(self) -> TurningPoints:
-        p = bindings.krz_mino_time_to_turning_points(self._path_builder)
-        return TurningPoints(theta_0=p.theta_0, theta_1=p.theta_1, r_0=p.r_0, r_1=p.r_1)
-
-
-def trace_impact_parameters(
-    alpha, beta, r=1e4, theta=1.0, a=0.998, M=1.0
-) -> NullGeodesic:
-    metric = bindings.krz_kerrMetric(M, a)
-    ic = bindings.krz_InitialConditions()
-    x_init = bindings.krz_FourVector(t=0.0, r=r, th=theta, ph=0.0)
-
-    bindings.krz_fromImpactParameters(ctypes.byref(ic), metric, x_init, alpha, beta)
-
-    pb = bindings.krz_PathBuilder()
-    bindings.krz_PathBuilder_init(ctypes.byref(pb), metric, ic)
-
-    return NullGeodesic(pb)
-
-
-__all__ = [Status, GeodesicPoint, TurningPoints, NullGeodesic, trace_impact_parameters]

kerrz_python-0.1.0/kerrz_python.egg-info/requires.txt

@@ -1 +0,0 @@
-kerrz_lib>=0.1.15