PythonicDISORT 1.3__tar.gz → 1.4__tar.gz

{pythonicdisort-1.3/src/PythonicDISORT.egg-info → pythonicdisort-1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PythonicDISORT
-Version: 1.3
+Version: 1.4
 Summary: Discrete Ordinates Solver for the (1D) Radiative Transfer Equation in a single or multi-layer atmosphere.
 Author-email: Dion HO Jia Xu <dh3065@columbia.edu>
 Project-URL: Homepage, https://github.com/LDEO-CREW/Pythonic-DISORT
@@ -81,10 +81,10 @@ These notebooks double up as examples of how to use PythonicDISORT. The tests wh
 * Python 3.8+
 * `numpy >= 1.8.0`
 * `scipy >= 1.8.0`
+* (OPTIONAL) `autograd >= 1.5`
 * (OPTIONAL) `pytest >= 6.2.5` (Required to use the command `pytest`, see *PyTest and examples of how to use PythonicDISORT*)
 
 ## (OPTIONAL) Additional requirements to run the Jupyter Notebook
-* `autograd >= 1.5`
 * `jupyter > 1.0.0`
 * `notebook > 6.5.2`
 * `matplotlib >= 3.6.0`
@@ -127,3 +127,4 @@ Science and Technology Center (STC) (Award #2019625) under which this package wa
 12) T. Nakajima and M. Tanaka. 1988. *Algorithms for radiative intensity calculations in moderately thick atmospheres using a truncation approximation.* https://www.sciencedirect.com/science/article/pii/0022407388900313.
 
 13) Connour, Kyle and Wolff, Michael. 2020. *pyRT_DISORT: A pre-processing front-end to help make DISORT simulations easier in Python.* https://github.com/kconnour/pyRT_DISORT.
+

{pythonicdisort-1.3 → pythonicdisort-1.4}/README.md

@@ -60,10 +60,10 @@ These notebooks double up as examples of how to use PythonicDISORT. The tests wh
 * Python 3.8+
 * `numpy >= 1.8.0`
 * `scipy >= 1.8.0`
+* (OPTIONAL) `autograd >= 1.5`
 * (OPTIONAL) `pytest >= 6.2.5` (Required to use the command `pytest`, see *PyTest and examples of how to use PythonicDISORT*)
 
 ## (OPTIONAL) Additional requirements to run the Jupyter Notebook
-* `autograd >= 1.5`
 * `jupyter > 1.0.0`
 * `notebook > 6.5.2`
 * `matplotlib >= 3.6.0`
@@ -106,3 +106,4 @@ Science and Technology Center (STC) (Award #2019625) under which this package wa
 12) T. Nakajima and M. Tanaka. 1988. *Algorithms for radiative intensity calculations in moderately thick atmospheres using a truncation approximation.* https://www.sciencedirect.com/science/article/pii/0022407388900313.
 
 13) Connour, Kyle and Wolff, Michael. 2020. *pyRT_DISORT: A pre-processing front-end to help make DISORT simulations easier in Python.* https://github.com/kconnour/pyRT_DISORT.
+

{pythonicdisort-1.3 → pythonicdisort-1.4}/pyproject.toml

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

{pythonicdisort-1.3 → pythonicdisort-1.4}/src/PythonicDISORT/pydisort.py

@@ -451,40 +451,33 @@ def pydisort(
             
             neg_scaled_tau_div_mu0 = -scaled_tau / mu0
             if is_antiderivative_wrt_tau:
-            
-                scale_tau_l = scale_tau[None, l_uniq]
+
+                scale_tau_l = scale_tau[l_uniq]
                 neg_scale_tau_l_div_mu0 = -scale_tau_l / mu0
-                scale_tau_l_div_mu_arr_pos = scale_tau_l / mu_arr_pos[:, None]
-                
+                scale_tau_l_div_mu_arr_pos = scale_tau_l[None, :] / mu_arr_pos[:, None]
+
                 TMS_correction_pos = (
-                    np.exp(neg_scaled_tau_div_mu0)[None, :] / neg_scale_tau_l_div_mu0[l_inv]
-                    - np.exp(
-                        (scaled_tau - scaled_tau_arr_l)[None, :] / mu_arr_pos[:, None]
-                        - scaled_tau_arr_l[None, :] / mu0
-                    ) / scale_tau_l_div_mu_arr_pos[l_inv]
-                )
+                    np.exp(neg_scaled_tau_div_mu0) / neg_scale_tau_l_div_mu0[l_inv]
+                )[None, :] - np.exp(
+                    (scaled_tau - scaled_tau_arr_l)[None, :] / mu_arr_pos[:, None]
+                    - scaled_tau_arr_l[None, :] / mu0
+                ) / scale_tau_l_div_mu_arr_pos[:, l_inv]
                 TMS_correction_neg = (
-                    np.exp(neg_scaled_tau_div_mu0)[None, :] / neg_scale_tau_l_div_mu0[l_inv]
-                    + np.exp(
-                        (scaled_tau_arr_lm1 - scaled_tau)[None, :] / mu_arr_pos[:, None]
-                        - scaled_tau_arr_lm1[None, :] / mu0
-                    ) / scale_tau_l_div_mu_arr_pos[l_inv]
-                )
+                    np.exp(neg_scaled_tau_div_mu0) / neg_scale_tau_l_div_mu0[l_inv]
+                )[None, :] + np.exp(
+                    (scaled_tau_arr_lm1 - scaled_tau)[None, :] / mu_arr_pos[:, None]
+                    - scaled_tau_arr_lm1[None, :] / mu0
+                ) / scale_tau_l_div_mu_arr_pos[:, l_inv]
             else:
-                TMS_correction_pos = (
-                    np.exp(neg_scaled_tau_div_mu0)[None, :]
-                    - np.exp(
-                        (scaled_tau - scaled_tau_arr_l)[None, :] / mu_arr_pos[:, None]
-                        - scaled_tau_arr_l[None, :] / mu0
-                    )
+                TMS_correction_pos = np.exp(neg_scaled_tau_div_mu0)[None, :] - np.exp(
+                    (scaled_tau - scaled_tau_arr_l)[None, :] / mu_arr_pos[:, None]
+                    - scaled_tau_arr_l[None, :] / mu0
                 )
-                TMS_correction_neg = (
-                    np.exp(neg_scaled_tau_div_mu0)[None, :]
-                    - np.exp(
-                        (scaled_tau_arr_lm1 - scaled_tau)[None, :] / mu_arr_pos[:, None]
-                        - scaled_tau_arr_lm1[None, :] / mu0
-                    )
+                TMS_correction_neg = np.exp(neg_scaled_tau_div_mu0)[None, :] - np.exp(
+                    (scaled_tau_arr_lm1 - scaled_tau)[None, :] / mu_arr_pos[:, None]
+                    - scaled_tau_arr_lm1[None, :] / mu0
                 )
+
             
             ## Contribution from other layers
             # --------------------------------------------------------------------------------------------------------------------------
@@ -525,13 +518,13 @@ def pydisort(
                 # POS: pre-accumulate "contribution from below" sums Rpos[N, l, Nphi]
                 # ====================================================================
                 if any_pos:
-                    # fac_pos = 1 - exp(-scaled_thickness_arr*(1/mu + 1/mu0)) = -expm1(-thickness_pos)
                     thickness_pos = scaled_thickness_arr[None, :] * (M_inv + mu0_inv)[:, None]  # (N, NLayers); always > 0
-                    fac_pos = -np.expm1(-thickness_pos)                                         # (N, NLayers)
+                    # em1_pos = 1 - exp(-scaled_thickness_arr*(1/mu + 1/mu0)) = -expm1(-thickness_pos)
+                    em1_pos = -np.expm1(-thickness_pos)                                         # (N, NLayers)
                     if is_antiderivative_wrt_tau:
-                        fac_pos = fac_pos * integration_factor
+                        em1_pos = integration_factor * em1_pos
 
-                    layer_term_pos = fac_pos * exp_taufront_mu0_inv[None, :]                    # (N, NLayers)
+                    layer_term_pos = em1_pos * exp_taufront_mu0_inv[None, :]                    # (N, NLayers)
 
                     # Reverse-scan via cumsum:
                     # Rpos[l] = (1/decay_prod[l+1]) * sum_{r=l+1..} (layer_term_pos[r] * decay_prod[r])
@@ -566,12 +559,12 @@ def pydisort(
                     exp_x0 = decay * exp_taufront_mu0_inv[None, :]                               # (N, NLayers)
 
                     # Let a = |thickness_neg| >= 0. Then expm1(-a) uses only non-positive inputs.
-                    em1 = np.expm1(-np.abs(thickness_neg))                                       # (N, NLayers)
+                    em1_neg = np.expm1(-np.abs(thickness_neg))                                       # (N, NLayers)
 
-                    # thickness_neg>=0: exp_x1 * (1 - exp(-a)) = exp_x1 * (-expm1(-a)) = exp_x1 * (-em1)
-                    # thickness_neg<0 : exp_x0 * (exp(-a) - 1) = exp_x0 * expm1(-a)    = exp_x0 * ( em1)
-                    layer_term_negthick = em1 * exp_x0                                           # (N, NLayers)
-                    layer_term_posthick = -em1 * exp_x1                                          # (N, NLayers)
+                    # thickness_neg>=0: exp_x1 * (1 - exp(-a)) = exp_x1 * (-expm1(-a)) = exp_x1 * (-em1_neg)
+                    # thickness_neg<0 : exp_x0 * (exp(-a) - 1) = exp_x0 * expm1(-a)    = exp_x0 * ( em1_neg)
+                    layer_term_negthick = em1_neg * exp_x0                                       # (N, NLayers)
+                    layer_term_posthick = -em1_neg * exp_x1                                      # (N, NLayers)
                     layer_term_neg = layer_term_posthick * mask + layer_term_negthick * (~mask)  # (N, NLayers)
 
                     if is_antiderivative_wrt_tau:

{pythonicdisort-1.3 → pythonicdisort-1.4}/src/PythonicDISORT/subroutines.py

@@ -489,8 +489,8 @@ def generate_emissivity_from_BDRF(N, zeroth_BDRF_Fourier_mode):
 
 def cache_BDRF_Fourier_modes(N, BDRF_Fourier_modes, mu0=0):
     """If the same BDRF and number of streams will be used repeatedly,
-    consider using this function to cache ``BDRF_Fourier_modes`` and instead input
-    ``cached_BDRF_Fourier_modes`` into ``pydisort``. It is also possible
+    consider using this function to cache ``BDRF_Fourier_modes`` and pass
+    ``cached_BDRF_Fourier_modes`` to ``pydisort``. It is also possible
     to cache ``BDRF_Fourier_modes`` with respect to a fixed ``mu0``. 
 
     Parameters

{pythonicdisort-1.3 → pythonicdisort-1.4/src/PythonicDISORT.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PythonicDISORT
-Version: 1.3
+Version: 1.4
 Summary: Discrete Ordinates Solver for the (1D) Radiative Transfer Equation in a single or multi-layer atmosphere.
 Author-email: Dion HO Jia Xu <dh3065@columbia.edu>
 Project-URL: Homepage, https://github.com/LDEO-CREW/Pythonic-DISORT
@@ -81,10 +81,10 @@ These notebooks double up as examples of how to use PythonicDISORT. The tests wh
 * Python 3.8+
 * `numpy >= 1.8.0`
 * `scipy >= 1.8.0`
+* (OPTIONAL) `autograd >= 1.5`
 * (OPTIONAL) `pytest >= 6.2.5` (Required to use the command `pytest`, see *PyTest and examples of how to use PythonicDISORT*)
 
 ## (OPTIONAL) Additional requirements to run the Jupyter Notebook
-* `autograd >= 1.5`
 * `jupyter > 1.0.0`
 * `notebook > 6.5.2`
 * `matplotlib >= 3.6.0`
@@ -127,3 +127,4 @@ Science and Technology Center (STC) (Award #2019625) under which this package wa
 12) T. Nakajima and M. Tanaka. 1988. *Algorithms for radiative intensity calculations in moderately thick atmospheres using a truncation approximation.* https://www.sciencedirect.com/science/article/pii/0022407388900313.
 
 13) Connour, Kyle and Wolff, Michael. 2020. *pyRT_DISORT: A pre-processing front-end to help make DISORT simulations easier in Python.* https://github.com/kconnour/pyRT_DISORT.
+