##########################################
**The astro modules and programs**
##########################################

**Module astro_bin_vero**
======================================


**Module   : astro_bin_vero**

**Purpose  : Version of centrifugally disorted star to account for phase locked binary.**


.. class::  star_t


.. class::  discfunc_t


.. function:: star_t_ (m, ar) result (st)


.. function:: Phi_eff_ (this, vr) result (Phi_eff)


.. function:: vg_eff_ (this, vr) result (vg_eff)


.. function:: vn_eff_ (this, vr) result (vn_eff)


.. function:: D_surf_ (this, vr) result (D_surf)


.. function:: Sigma_0_ (this) result (Sigma_0)


.. function:: Sigma_1_ (this) result (Sigma_1)


.. function:: A_surf_ (this) result (A_surf)


.. function:: R_surf_ (this, theta) result (R_surf)


.. function:: s_surf_ (this, vr_0, vdr) result (s_surf)


.. function:: eval_c_ (this, z) result (f_z)


.. function:: read_ (hg, st)


.. function:: write_ (hg, st)


.. function:: bcast_ (st, root_rank)



**Module astro_hough**
======================================


**Module  : astro_hough**

**Purpose : calculation of Hough eigenvalues & eigenfunctions, incl. hough_t type**


.. class::  hough_t


.. function:: hough_t_n_ (nu, m, k, n) result (ho)


.. function:: hough_t_tol_ (nu, m, k, tol) result (ho)


.. function:: Theta_ (this, mu) result (Theta)


.. function:: Theta_xi_ (this, mu) result (Theta_xi)


.. function:: Xi_ (nu, m, n, parity)


.. function:: J_lm_ (l, m)


.. function:: P_lm_series (n, m, x) result (P_lm)


.. function:: dP_lm_series (n, m, x) result (dP_lm)


.. function:: N_lm_series (n, m) result (N_lm)


.. function:: lambda_n_ (nu, m, k, n) result (lambda)


.. function:: lambda_tol_ (nu, m, k, tol) result (lambda)


.. function:: lambda_asymp (nu, m, k) result (lambda)


.. function:: lambda_3 (nu, m, k) result (lambda)


.. function:: eval_coeffs_ (nu, m, k, lambda, b, c_r, c_t, c_p)


.. function:: eval_eigvecs_ (nu, m, k, lambda, b, q, r)


.. function:: eigen_W_n_ (nu, m, k, n, lambda, b)


.. function:: eigen_W_tol_ (nu, m, k, tol, lambda, b)


.. function:: eigen_A_i_ (nu, m, parity, n, i, k, lambda, b)


.. function:: eval_A_ (nu, m, n, parity, A_D, A_E)


.. function:: assemble_A_ (nu, m, n, parity, A_1, A_2n, A_2d, A_3n, A_3d, A_4n, A_4d, A_5, A_D, A_E)


.. function:: save_ieee_state_ (h_over, h_zero, h_inval)


.. function:: restore_ieee_state_ (h_over, h_zero, h_inval)



**Module astro_orbit**
======================================


**Module   : astro_orbit**

**Purpose  : binary orbits**


.. class::  orbit_t


.. class::  lagrange_func_t


.. function:: phase_ (this, t, t_peri) result (phase)


.. function:: a_ (this, star) result (a)


.. function:: rho_ (this, upsilon, star) result (rho)


.. function:: rho_dot_ (this, upsilon, star) result (rho_dot)


.. function:: r_ (this, phase, star) result (r)


.. function:: r_dot_ (this, phase, star) result (r_dot)


.. function:: upsilon_ (this, phase, star) result (upsilon)


.. function:: E_5_ (e, M) result (E_5)


.. function:: upsilon_dot_ (this, phase, star) result (upsilon_dot)


.. function:: vr_ (this, phase, star) result (vr)


.. function:: vv_ (this, phase, star) result (vv)


.. function:: vr_L_ (this, phase, i) result (vr_L)


.. function:: eval_c_ (this, z) result (f_z)


.. function:: lagrange_force (lf, x) result (f)



**Module astro_star**
======================================


**Module   : astro_star**

**Purpose  : centrifugally disorted star**


.. class::  star_t


.. class::  discfunc_t


.. function:: star_t_ (omega) result (st)

   Testing the docstrings
   Another line of doc string
   Here's the more complete description
   that continues on another line

.. function:: Phi_eff_ (this, vr) result (Phi_eff)

   Calculate the effective potential (units: G M_star/R_pole) at vr
   (units: R_pole)
   
   :param this: a star_t object
   :param vr:   a position
   :rtype Phi_eff: the potential as position vr

.. function:: vg_eff_ (this, vr) result (vg_eff)


.. function:: vn_eff_ (this, vr) result (vn_eff)


.. function:: D_surf_ (this, vr) result (D_surf)


.. function:: Sigma_0_ (this) result (Sigma_0)


.. function:: Sigma_1_ (this) result (Sigma_1)


.. function:: A_surf_ (this) result (A_surf)


.. function:: R_surf_ (this, theta) result (R_surf)


.. function:: s_surf_ (this, vr_0, vdr) result (s_surf)


.. function:: eval_c_ (this, z) result (f_z)


.. function:: read_ (hg, st)


.. function:: write_ (hg, st)


.. function:: bcast_ (st, root_rank)