pythonCRO 0.1.8__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,88 @@
1
+ Metadata-Version: 2.4
2
+ Name: pythonCRO
3
+ Version: 0.1.8
4
+ Summary: Community Recharge Oscillator
5
+ Author: CRO team led by Soong-Ki Kim and Sen Zhao
6
+ License: CC-BY-4.0
7
+ Project-URL: Homepage, https://github.com/senclimate/CRO
8
+ Project-URL: Documentation, https://senclimate.github.io/CRO/python/
9
+ Project-URL: Repository, https://github.com/senclimate/CRO
10
+ Project-URL: Issues, https://github.com/senclimate/CRO/issues
11
+ Requires-Python: >=3.9
12
+ Description-Content-Type: text/markdown
13
+ License-File: LICENSE
14
+ Requires-Dist: numpy>=1.20
15
+ Requires-Dist: scipy>=1.8
16
+ Requires-Dist: pandas>=1.3
17
+ Requires-Dist: xarray>=2023.1.0
18
+ Requires-Dist: matplotlib>=3.5
19
+ Requires-Dist: statsmodels>=0.13
20
+ Dynamic: license-file
21
+
22
+ # CRO: Community Recharge Oscillator Model
23
+
24
+ ## What is CRO?
25
+
26
+ The recharge oscillator (RO) model is one of the leading theoretical frameworks for understanding the El Niño–Southern Oscillation (Jin, 1997, Jin et al., 2020, Vialard et al., 2025).
27
+
28
+ While many RO variants exist in the literature, **CRO** is an open-source Python/Matlab package for:
29
+
30
+ - solving the recharge oscillator equations
31
+ - fitting model parameters to observational and climate model data
32
+ - applying the model in research and teaching applications
33
+
34
+ Key methodological foundations are described in Kim et al. (2025).
35
+
36
+ ---
37
+
38
+ ## Key Features
39
+
40
+ - **Solver**: Numerical and analytical solvers for the RO equations.
41
+
42
+ - **Fitting**: Parameter estimation from observations, reanalysis, or climate model data.
43
+
44
+ - **Applications**: Simulations, sensitivity experiments, and analysis of ENSO dynamics.
45
+
46
+ ---
47
+
48
+ ## Installation
49
+
50
+ ```bash
51
+ pip install CRO
52
+ ```
53
+
54
+ ---
55
+
56
+ ## Quick Start (Python)
57
+
58
+ ```python
59
+ import pyCRO
60
+
61
+ print(pyCRO.__version__)
62
+ ```
63
+
64
+ ---
65
+
66
+ ## Data Included
67
+
68
+ CRO includes curated datasets for benchmarking and teaching:
69
+
70
+ - Precomputed ORAS5 ENSO SST and WWV indices
71
+ - Precomputed CESM1 Large Ensemble ENSO time series
72
+ - Precomputed CMIP6 ENSO time series
73
+ - Precomputed parameter libraries
74
+
75
+ ---
76
+
77
+ ## Documentation
78
+
79
+ - Documentation: https://senclimate.github.io/CRO/python/
80
+ - Source code: https://github.com/senclimate/CRO
81
+
82
+ ---
83
+
84
+ ## Citation
85
+
86
+ If you use CRO in your research, please cite:
87
+
88
+ Kim, S.-K., Zhao, S., & et al. (2025). Community Recharge Oscillator (CRO) v1.0: an open-source Python and MATLAB package for solving, parameter fitting, and practical applications of the ENSO recharge oscillator. In preparation.
@@ -0,0 +1,67 @@
1
+ # CRO: Community Recharge Oscillator Model
2
+
3
+ ## What is CRO?
4
+
5
+ The recharge oscillator (RO) model is one of the leading theoretical frameworks for understanding the El Niño–Southern Oscillation (Jin, 1997, Jin et al., 2020, Vialard et al., 2025).
6
+
7
+ While many RO variants exist in the literature, **CRO** is an open-source Python/Matlab package for:
8
+
9
+ - solving the recharge oscillator equations
10
+ - fitting model parameters to observational and climate model data
11
+ - applying the model in research and teaching applications
12
+
13
+ Key methodological foundations are described in Kim et al. (2025).
14
+
15
+ ---
16
+
17
+ ## Key Features
18
+
19
+ - **Solver**: Numerical and analytical solvers for the RO equations.
20
+
21
+ - **Fitting**: Parameter estimation from observations, reanalysis, or climate model data.
22
+
23
+ - **Applications**: Simulations, sensitivity experiments, and analysis of ENSO dynamics.
24
+
25
+ ---
26
+
27
+ ## Installation
28
+
29
+ ```bash
30
+ pip install CRO
31
+ ```
32
+
33
+ ---
34
+
35
+ ## Quick Start (Python)
36
+
37
+ ```python
38
+ import pyCRO
39
+
40
+ print(pyCRO.__version__)
41
+ ```
42
+
43
+ ---
44
+
45
+ ## Data Included
46
+
47
+ CRO includes curated datasets for benchmarking and teaching:
48
+
49
+ - Precomputed ORAS5 ENSO SST and WWV indices
50
+ - Precomputed CESM1 Large Ensemble ENSO time series
51
+ - Precomputed CMIP6 ENSO time series
52
+ - Precomputed parameter libraries
53
+
54
+ ---
55
+
56
+ ## Documentation
57
+
58
+ - Documentation: https://senclimate.github.io/CRO/python/
59
+ - Source code: https://github.com/senclimate/CRO
60
+
61
+ ---
62
+
63
+ ## Citation
64
+
65
+ If you use CRO in your research, please cite:
66
+
67
+ Kim, S.-K., Zhao, S., & et al. (2025). Community Recharge Oscillator (CRO) v1.0: an open-source Python and MATLAB package for solving, parameter fitting, and practical applications of the ENSO recharge oscillator. In preparation.
Binary file
Binary file
@@ -0,0 +1,16 @@
1
+ # __init__.py
2
+
3
+ __version__ = "0.1.8"
4
+
5
+ from .fitting import RO_fitting
6
+ from .solver import RO_solver
7
+
8
+ from .analytic import RO_analytic_std, RO_analytic_solver
9
+
10
+ from .utils import RO_BWJ, func_mon_std
11
+ from .par_load import par_load
12
+
13
+ from .fit_LR import fit_LR
14
+ from .fit_MLE import fit_MLE
15
+
16
+ from .visual import plot_RO_par, plot_ens_RO_par
@@ -0,0 +1,244 @@
1
+ import sys
2
+ import numpy as np
3
+
4
+ def RO_analytic_std(par):
5
+ """
6
+ Compute analytical standard deviation of T and h for the Recharge Oscillator (RO) model.
7
+ ONLY for linear RO model with white noise (annual mean parameters only)
8
+
9
+ Parameters
10
+ ----------
11
+ par : dict
12
+ Dictionary containing parameter arrays:
13
+ 'R', 'F1', 'epsilon', 'F2', 'sigma_T', 'sigma_h'.
14
+
15
+ Returns
16
+ -------
17
+ T_std : float
18
+ Standard deviation of T.
19
+ h_std : float
20
+ Standard deviation of h.
21
+ """
22
+
23
+ R_value = par['R'][0]
24
+ F1_value = par['F1'][0]
25
+ epsilon_value = par['epsilon'][0]
26
+ F2_value = par['F2'][0]
27
+ sigma_T_value = par['sigma_T'][0]
28
+ sigma_h_value = par['sigma_h'][0]
29
+
30
+ # Precompute useful terms
31
+ numerator_T = ((F1_value * F2_value - epsilon_value * R_value + epsilon_value**2) * sigma_T_value**2 +
32
+ (F1_value**2) * sigma_h_value**2)
33
+ denominator = 2 * (-R_value + epsilon_value) * (F1_value * F2_value - R_value * epsilon_value)
34
+ T_std = np.sqrt(numerator_T / denominator)
35
+
36
+ numerator_h = ((F2_value**2) * sigma_T_value**2 +
37
+ (F1_value * F2_value - epsilon_value * R_value + R_value**2) * sigma_h_value**2)
38
+ h_std = np.sqrt(numerator_h / denominator)
39
+
40
+ return T_std, h_std
41
+
42
+
43
+ def RO_analytic_solver(par, IC, N, NE, dt=0.1, saveat=1.0, savemethod="sampling", noise_custom=None):
44
+ """
45
+ Analytical solution of the Recharge Oscillator (RO) model with deterministic and stochastic forcing.
46
+ ONLY for linear RO model with white noise (annual mean parameters only)
47
+
48
+ Parameters
49
+ ----------
50
+ par : dict
51
+ Dictionary of model parameters, each as at least a one-element array:
52
+
53
+ - ``'R'`` : float
54
+ Damping parameter.
55
+ - ``'F1'`` : float
56
+ Feedback parameter relating thermocline depth to SST.
57
+ - ``'epsilon'`` : float
58
+ Thermocline damping parameter.
59
+ - ``'F2'`` : float
60
+ Feedback parameter relating SST to thermocline.
61
+ - ``'sigma_T'`` : float
62
+ Noise amplitude for SST.
63
+ - ``'sigma_h'`` : float
64
+ Noise amplitude for thermocline depth.
65
+ IC : tuple of float
66
+ Initial condition ``(To, ho)``:
67
+
68
+ - ``To`` : initial SST anomaly.
69
+ - ``ho`` : initial thermocline depth anomaly.
70
+ N : float
71
+ Total simulation length (time units).
72
+ NE : int
73
+ Number of ensemble members.
74
+ dt : float, optional
75
+ Numerical integration time step. Default is ``0.1``.
76
+ saveat : float, optional
77
+ Output saving interval. Must be divisible by ``dt``. Default is ``1.0``.
78
+ savemethod : {'sampling', 'mean'}, optional
79
+ Method for saving results:
80
+
81
+ - ``'sampling'`` : take samples every ``saveat``.
82
+ - ``'mean'`` : average values over each ``saveat`` interval.
83
+ noise_custom : {None, int, ndarray}, optional
84
+ Specification of stochastic noise:
85
+
86
+ - ``None`` (default): new Gaussian noise is generated for each ensemble.
87
+ - ``int`` : seed for reproducible noise (same across ensembles).
88
+ - ``ndarray`` of shape ``(NT-1, 4)`` : user-provided noise, repeated across ensembles.
89
+ - ``ndarray`` of shape ``(NT-1, 4, NE)`` : user-provided noise for each ensemble.
90
+
91
+ Returns
92
+ -------
93
+ T_anal_out : ndarray of shape (N_out, NE)
94
+ SST anomalies including deterministic and stochastic forcing,
95
+ after applying the saving scheme. The final row is NaN-padded
96
+ for dimensional consistency.
97
+ h_anal_out : ndarray of shape (N_out, NE)
98
+ Thermocline anomalies including deterministic and stochastic forcing,
99
+ after applying the saving scheme. The final row is NaN-padded.
100
+ noise_array : ndarray of shape (NT-1, 4, NE)
101
+ Realizations of Gaussian noise used in the simulation.
102
+
103
+ Notes
104
+ -----
105
+ The analytical solution consists of:
106
+
107
+ - Deterministic part: exponential-sinusoidal functions of time.
108
+ - Stochastic part: weighted sums (discrete convolutions) of noise
109
+ with exponential and sinusoidal kernels.
110
+
111
+ Ensemble members are evaluated simultaneously using vectorized
112
+ NumPy broadcasting, avoiding explicit Python loops.
113
+
114
+ Examples
115
+ --------
116
+ >>> par = {'R':[0.5], 'F1':[1.2], 'epsilon':[0.3], 'F2':[0.8],
117
+ ... 'sigma_T':[0.2], 'sigma_h':[0.1]}
118
+ >>> IC = (0.1, -0.2)
119
+ >>> T, h, noise = RO_solver_analytic(par, IC, N=50, NE=10, dt=0.1, saveat=1.0)
120
+ >>> T.shape, h.shape
121
+ ((51, 10), (51, 10))
122
+ """
123
+
124
+ NT = int(round(N / dt))
125
+ step = int(round(saveat / dt))
126
+ ratio = saveat / dt
127
+
128
+ ### Checking simulation setups ###
129
+ ##################################
130
+ print("---------------------------------------------------------------------------------")
131
+ print("Welcome to the CRO Analytical Solver!")
132
+ print("Ensure that the same arguments are provided as for RO_solver,\n except that 'NM' and 'EF' are not required.")
133
+ print("---------------------------------------------------------------------------------")
134
+
135
+ ### Check timestep settings ###
136
+ if dt > saveat:
137
+ raise ValueError(f"dt={dt} and saveat={saveat}: The numerical time step (dt) must be smaller than or equal to the data saving interval (saveat).")
138
+ if not ratio.is_integer():
139
+ raise ValueError(f"dt = {dt}, saveat = {saveat}: saveat must be divisible by dt so that saveat/dt results in an integer.")
140
+ ###############################
141
+
142
+ ### extracting linear and noise amplitude parameters ###
143
+ ########################################################
144
+ R_value = par['R'][0]
145
+ F1_value = par['F1'][0]
146
+ epsilon_value = par['epsilon'][0]
147
+ F2_value = par['F2'][0]
148
+ sigma_T_value = par['sigma_T'][0]
149
+ sigma_h_value = par['sigma_h'][0]
150
+ ########################################################
151
+ ########################################################
152
+
153
+
154
+ ### initial setups ###
155
+ ######################
156
+ To, ho = IC
157
+ t = np.arange(NT) * dt
158
+ gr = (R_value - epsilon_value) / 2
159
+ w = np.sqrt(4 * F1_value * F2_value - (R_value + epsilon_value)**2) / 2
160
+
161
+ T_anal_out = np.zeros((NT, NE))
162
+ h_anal_out = np.zeros((NT, NE))
163
+
164
+ T_det = np.exp(gr * t) * (To * np.cos(w * t) +
165
+ To * (R_value + epsilon_value) / (2 * w) * np.sin(w * t) +
166
+ ho * (F1_value / w) * np.sin(w * t))
167
+
168
+ h_det = np.exp(gr * t) * (ho * np.cos(w * t) -
169
+ ho * (R_value + epsilon_value) / (2 * w) * np.sin(w * t) -
170
+ To * (F2_value / w) * np.sin(w * t))
171
+ ######################
172
+ ######################
173
+
174
+ ########################################################
175
+ # Noise generation (vectorized for all NE)
176
+ if noise_custom is None:
177
+ noise_array = np.random.randn(NT - 1, 4, NE)
178
+ elif np.isscalar(noise_custom):
179
+ np.random.seed(int(noise_custom))
180
+ noise_array = np.random.randn(NT - 1, 4, NE)
181
+ elif noise_custom.shape == (NT - 1, 4):
182
+ noise_array = np.repeat(noise_custom[..., None], NE, axis=2)
183
+ elif noise_custom.shape == (NT - 1, 4, NE):
184
+ noise_array = noise_custom
185
+ else:
186
+ raise ValueError(f"Invalid 'noise_custom' input: expected None, scalar, shape ({NT-1},4) or ({NT-1},4,{NE}).")
187
+
188
+ w_T = sigma_T_value * noise_array[:, 0, :] / np.sqrt(dt) # (NT-1, NE)
189
+ w_h = sigma_h_value * noise_array[:, 1, :] / np.sqrt(dt) # (NT-1, NE)
190
+
191
+ # Vectorized convolution-like integral for stochastic terms
192
+ T_sto = np.zeros((NT - 1, NE))
193
+ h_sto = np.zeros((NT - 1, NE))
194
+
195
+ ### analytical calculations
196
+ ########################################################
197
+ for i in range(1, NT - 1):
198
+ tau = t[:i+1] # (i+1,)
199
+ delta = t[i] - tau # (i+1,)
200
+ sin = np.sin(w * delta) # (i+1,)
201
+ cos = np.cos(w * delta) # (i+1,)
202
+ expgr = np.exp(gr * delta) # (i+1,)
203
+
204
+ # (i+1, NE) via broadcasting
205
+ T_kernel = (
206
+ w_T[:i+1, :] * cos[:, None] +
207
+ w_T[:i+1, :] * (R_value + epsilon_value) / (2 * w) * sin[:, None] +
208
+ w_h[:i+1, :] * (F1_value / w) * sin[:, None]
209
+ )
210
+ h_kernel = (
211
+ w_h[:i+1, :] * cos[:, None] -
212
+ w_h[:i+1, :] * (R_value + epsilon_value) / (2 * w) * sin[:, None] -
213
+ w_T[:i+1, :] * (F2_value / w) * sin[:, None]
214
+ )
215
+
216
+ T_sto[i, :] = np.sum(dt * expgr[:, None] * T_kernel, axis=0)
217
+ h_sto[i, :] = np.sum(dt * expgr[:, None] * h_kernel, axis=0)
218
+
219
+ # Add deterministic and stochastic contributions
220
+ T_anal_out = np.vstack([T_det[:-1, None] + T_sto, np.full((1, NE), np.nan)])
221
+ h_anal_out = np.vstack([h_det[:-1, None] + h_sto, np.full((1, NE), np.nan)])
222
+
223
+ ### save data ###
224
+ #################
225
+ if savemethod == "sampling":
226
+ T_anal_out = T_anal_out[::step, :]
227
+ h_anal_out = h_anal_out[::step, :]
228
+ elif savemethod == "mean":
229
+ T_anal_out = T_anal_out[int(np.ceil(step/2)):NT-int(step/2),:]
230
+ h_anal_out = h_anal_out[int(np.ceil(step/2)):NT-int(step/2),:]
231
+ T_anal_out = T_anal_out.reshape(-1, step, NE).mean(axis=1)
232
+ h_anal_out = h_anal_out.reshape(-1, step, NE).mean(axis=1)
233
+ if NE > 1:
234
+ T_anal_out = np.vstack([T_anal_out[0:1, :], T_anal_out])
235
+ h_anal_out = np.vstack([h_anal_out[0:1, :], h_anal_out])
236
+ elif NE == 1:
237
+ T_anal_out = np.concatenate([[T_anal_out[0]], T_anal_out])
238
+ h_anal_out = np.concatenate([[h_anal_out[0]], h_anal_out])
239
+
240
+ print("All steps are successfully completed!")
241
+ print("---------------------------------------------------------------------------------")
242
+ #################
243
+ #################
244
+ return T_anal_out, h_anal_out, noise_array