kaitiaki.helpers
================

.. py:module:: kaitiaki.helpers


Classes
-------

.. autoapisummary::

   kaitiaki.helpers.Range


Functions
---------

.. autoapisummary::

   kaitiaki.helpers.RL
   kaitiaki.helpers.roche_lobes
   kaitiaki.helpers.contact_phases
   kaitiaki.helpers.find_runs


Module Contents
---------------

.. py:function:: RL(q, a, lobe='L1')

   Computes the roche lobe radius of a star in a binary.

   Uses the approximation by P. Eggleton for L1, and P. Marchant for L2.
   - Eggleton (1983): https://ui.adsabs.harvard.edu/abs/1983ApJ...268..368E/abstract
   - Marchant et al (2016): https://ui.adsabs.harvard.edu/abs/2016A%26A...588A..50M/abstract

   Note that Eggleton takes q=m2/m1, whereas Marchant takes m1/m2. For consistency, we have elected to take q=m2/m1.


   :param q: The mass ratio to compute for. Note that q=m2/m1.
   :type q: float
   :param a: The binary separation
   :type a: float
   :param lobe: Whether to compute L1 or L2 (default: `'L1'`)
   :type lobe: str

   :returns: The roche lobe radius (in real units)
   :rtype: float


.. py:function:: roche_lobes(donor_plotfile, accretor_plotfile)

.. py:function:: contact_phases(donor_plotfile, accretor_plotfile)

.. py:function:: find_runs(x)

   Find runs of consecutive items in an array.

   https://gist.github.com/alimanfoo/c5977e87111abe8127453b21204c1065


.. py:class:: Range(bound_low, bound_high, inclusivity='[]', mutable=False)

   .. py:attribute:: _bound_low


   .. py:attribute:: _bound_high


   .. py:attribute:: _right_inclusive


   .. py:attribute:: _inclusives
      :value: [None, None]



   .. py:attribute:: _mutable
      :value: False



   .. py:method:: __contains__(item)


   .. py:method:: __getitem__(idx)


   .. py:method:: inclusives()


   .. py:method:: __setitem__(key, val)


   .. py:method:: __str__()