Source code for jaxoplanet.proto

__all__ = ["LightCurveOrbit"]

from typing import Protocol

from jaxoplanet.types import Scalar




[docs]
class LightCurveOrbit(Protocol):
    """An interface for orbits that can be used to compute light curves"""

    @property


[docs]
    def shape(self) -> tuple[int, ...]: ...



    @property


[docs]
    def radius(self) -> Scalar: ...





[docs]
    def relative_position(self, t: Scalar) -> tuple[Scalar, Scalar, Scalar]: ...



    @property


[docs]
    def central_radius(self) -> Scalar: ...