v1.0.1 ready. The restriction on the phase function Legendre coefficients Leg_coeffs_all is corrected from [0, 1] to [-1, 1].

Author: dhjx1996

docs/Pythonic-DISORT.ipynb

@@ -587,7 +587,7 @@
    "source": [
     "* **Unweighted phase function Legendre coefficients** $g_\\ell$ **(PMOM)**\n",
     "\n",
-    "We require at least $\\text{NLeg}$ coefficients each between $0$ and $1$ inclusive. For a multi-layer atmosphere, `Leg_coeffs_all` must be a matrix which $l$th row index corresponds to the atmospheric layer indexed by $l$."
+    "We require at least $\\text{NLeg}$ coefficients each between $-1$ and $1$ inclusive. For a multi-layer atmosphere, `Leg_coeffs_all` must be a matrix which $l$th row index corresponds to the atmospheric layer indexed by $l$."
    ]
   },
   {

docs/conf.py

@@ -9,7 +9,7 @@
 project = 'Pythonic DISORT'
 copyright = '2023, HO Jia Xu Dion'
 author = 'Dion HO Jia Xu'
-release = '1.0.0'
+release = '1.0.1'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

pyproject.toml

@@ -8,7 +8,7 @@ dependencies = [
   "scipy>=1.8.0",
 ]
 name = "PythonicDISORT"
-version = "1.0.0"
+version = "1.0.1"
 authors = [
   { name="Dion HO Jia Xu", email="dh3065@columbia.edu" },
 ]

src/PythonicDISORT/_assemble_intensity_and_fluxes.py

@@ -592,6 +592,6 @@ def flux_down(tau, is_antiderivative_wrt_tau=False, return_tau_arr=False):
         # --------------------------------------------------------------------------------------------------------------------------
 
     if only_flux:
-        return flux_up, flux_down, u0#, GC_collect_0, K_collect_0
+        return flux_up, flux_down, u0#, GC_collect_0, K_collect_0, B_collect_0
     else:
         return flux_up, flux_down, u0, u

src/PythonicDISORT/_solve_for_coeffs.py

@@ -87,7 +87,7 @@ def _solve_for_coeffs(
     # The following loops can easily be parallelized, but the speed-up is unlikely to be worth the overhead
     for m in range(NFourier):
         m_equals_0 = (m == 0)
-        BDRF_bool = (NBDRF > m) 
+        there_is_BDRF_mode = (NBDRF > m) 
 
         G_collect_m = G_collect[m, :, :, :]
         K_collect_m = K_collect[m, :, :]
@@ -97,7 +97,7 @@ def _solve_for_coeffs(
         # Generate mathscr_D and mathscr_X (BDRF terms)
         # Just for this part, refer to section 3.4.2 of the Comprehensive Documentation 
         # --------------------------------------------------------------------------------------------------------------------------
-        if BDRF_bool:
+        if there_is_BDRF_mode:
             mathscr_D_neg = (1 + m_equals_0 * 1) * BDRF_Fourier_modes[m](mu_arr_pos, mu_arr_pos)
             R = mathscr_D_neg * mu_arr_pos_times_W[None, :]
 
@@ -212,7 +212,7 @@ def _solve_for_coeffs(
                     * np.exp(-scaled_tau_arr_with_0 / mu0)[l_range, None]
                 ).ravel()
 
-            if BDRF_bool:
+            if there_is_BDRF_mode:
                 RHS = (
                     np.concatenate(
                         [
@@ -260,7 +260,7 @@ def _solve_for_coeffs(
             G_0_np
             * np.exp(K_collect_m[0, :N] * scaled_tau_arr_with_0[1])[None, :]
         )
-        if BDRF_bool:
+        if there_is_BDRF_mode:
             LHS[-N:, -NQuad : -N] = (G_L_pn - R @ G_L_nn) * E_Lm1L[None, :]
             LHS[-N:, -N:] = G_L_pp - R @ G_L_np
         else:

src/PythonicDISORT/pydisort.py

@@ -232,8 +232,8 @@ def pydisort(
         raise ValueError("The number of phase function Legendre coefficients must be positive.") 
     if not np.all(omega_arr * Leg_coeffs_all[:, 0] == omega_arr):
         raise ValueError("The first phase function Legendre coefficient must equal 1.") 
-    if not (np.all(0 <= Leg_coeffs_all) and np.all(Leg_coeffs_all <= 1)):
-        raise ValueError("The phase function Legendre coefficients must all be between 0 and 1.") 
+    if not (np.all(-1 <= Leg_coeffs_all) and np.all(Leg_coeffs_all <= 1)):
+        raise ValueError("The phase function Legendre coefficients must all be between -1 and 1.") 
     if not NLeg <= NLeg_all:
         raise ValueError("`NLeg` cannot be larger than the number of phase function Legendre coefficients provided.")
     # Ensure that the first dimension of the following inputs corresponds to the number of layers
@@ -263,9 +263,9 @@ def pydisort(
     if I0 < 0:
         raise ValueError("The incident beam must have positive intensity.")
     if there_is_beam_source:
-        if not 0 < mu0 and mu0 <= 1:
+        if not (0 < mu0 and mu0 <= 1):
             raise ValueError("The cosine of the polar angle of the incident beam must be between 0 and 1, excluding 0.")
-        if not 0 <= phi0 and phi0 < 2 * pi:
+        if not (0 <= phi0 and phi0 < 2 * pi):
             raise ValueError("Provide the principal azimuthal angle for the incident beam (must be between 0 and 2pi, excluding 2pi).")
     # Ensure that the BC inputs are of the correct shape
     if len(np.atleast_1d(b_pos)) == 1: