Updated documentation

Deltares · Mar 11, 2022 · a4ce858 · a4ce858
1 parent 02a1529
commit a4ce858
Show file tree

Hide file tree

Showing 5 changed files with 374 additions and 446 deletions.
diff --git a/docs/hatyan/analysis_prediction.html b/docs/hatyan/analysis_prediction.html
@@ -546,7 +546,7 @@ <h1 class="title">Module <code>hatyan.analysis_prediction</code></h1>
 
     print(&#39;PREDICTION started&#39;)
     omega_i_rads = t_const_speed_all.T/3600 #angular frequency, 2pi/T, in rad/s, https://en.wikipedia.org/wiki/Angular_frequency (2*np.pi)/(1/x*3600) = 2*np.pi*x/3600
-    if ~isinstance(times_pred_all_pdDTI,pd.DatetimeIndex) &amp; (version.parse(pd.__version__) &gt;= version.parse(&#39;1.2.0&#39;)): #fix for non-backwards compatible change in pandas, pandas version 1.1.2 is used for RWS version.
+    if ~isinstance(times_pred_all_pdDTI,pd.DatetimeIndex) &amp; (version.parse(pd.__version__) &gt;= version.parse(&#39;1.2.0&#39;)): #fix for non-backwards compatible change in pandas, pandas version 1.1.2 is used for RWS version. TODO: remove this fix once pandas&gt;=1.2.0 can be used (probably py3.7 required)
         times_from0allpred_s_orig = (times_pred_all_pdDTI-dood_date_start).total_seconds().values
     else:
         times_from0allpred_s_orig = (times_pred_all_pdDTI-dood_date_start[0]).total_seconds().values
@@ -1113,7 +1113,7 @@ <h2 id="returns">Returns</h2>
 
     print(&#39;PREDICTION started&#39;)
     omega_i_rads = t_const_speed_all.T/3600 #angular frequency, 2pi/T, in rad/s, https://en.wikipedia.org/wiki/Angular_frequency (2*np.pi)/(1/x*3600) = 2*np.pi*x/3600
-    if ~isinstance(times_pred_all_pdDTI,pd.DatetimeIndex) &amp; (version.parse(pd.__version__) &gt;= version.parse(&#39;1.2.0&#39;)): #fix for non-backwards compatible change in pandas, pandas version 1.1.2 is used for RWS version.
+    if ~isinstance(times_pred_all_pdDTI,pd.DatetimeIndex) &amp; (version.parse(pd.__version__) &gt;= version.parse(&#39;1.2.0&#39;)): #fix for non-backwards compatible change in pandas, pandas version 1.1.2 is used for RWS version. TODO: remove this fix once pandas&gt;=1.2.0 can be used (probably py3.7 required)
         times_from0allpred_s_orig = (times_pred_all_pdDTI-dood_date_start).total_seconds().values
     else:
         times_from0allpred_s_orig = (times_pred_all_pdDTI-dood_date_start[0]).total_seconds().values