orbix.kepler.shortcuts
======================

.. py:module:: orbix.kepler.shortcuts

.. autoapi-nested-parse::

   Computational shortcuts for Kepler's equation.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/orbix/kepler/shortcuts/fixed_e/index
   /autoapi/orbix/kepler/shortcuts/grid/index
   /autoapi/orbix/kepler/shortcuts/guess/index


Functions
---------

.. autoapisummary::

   orbix.kepler.shortcuts.get_grid_solver


Package Contents
----------------

.. py:function:: get_grid_solver(level='scalar', jit=False, kind='bilinear', E=True, trig=True, n_e=512, n_M=2048)

   Helper function to get a grid-based solver and cache it.

   :param level:
                 How the solver should be batching things.
                     - "scalar" means the inputs will be a single (M, e) pair and
                       the output will be a single E, sinE, cosE value.
                     - "planet" will vectorize over times first and then over
                       orbits.
                         - M: (n_orbits, n_times)
                         - e: (n_orbits,)
   :param jit: Whether to jit the solver.
   :param kind: The kind of solver to use, either "linear" or "bilinear".
   :param E: Whether to compute the eccentric anomaly.
   :param trig: Whether to compute the sine and cosine of the eccentric anomaly.
   :param n_e: The number of eccentricity steps in the grid.
   :param n_M: The number of mean anomaly steps in the grid.