From 7a4db7cfb1ea0b4b95fd46e7801d1e9b90a2c3ec Mon Sep 17 00:00:00 2001 From: Yumeng Chen Date: Fri, 1 Nov 2024 15:30:09 +0000 Subject: [PATCH] update doc --- docs/API_legacy.html | 328 ++++++++++++++++++ .../pyPDAF.PDAF.diag_CRPS_nompi.html | 165 +++++++++ docs/_sources/API_legacy.rst.txt | 84 +++++ .../pyPDAF.PDAF.diag_CRPS_nompi.rst.txt | 6 + 4 files changed, 583 insertions(+) create mode 100644 docs/API_legacy.html create mode 100644 docs/_autosummary/pyPDAF.PDAF.diag_CRPS_nompi.html create mode 100644 docs/_sources/API_legacy.rst.txt create mode 100644 docs/_sources/_autosummary/pyPDAF.PDAF.diag_CRPS_nompi.rst.txt diff --git a/docs/API_legacy.html b/docs/API_legacy.html new file mode 100644 index 00000000..dd4e8c8a --- /dev/null +++ b/docs/API_legacy.html @@ -0,0 +1,328 @@ + + + + + + + + API (legacy) — pyPDAF documentation + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

API (legacy)

+ +
+

DA algorithms

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

pyPDAF.PDAF.assimilate_3dvar

It is recommended to use pyPDAF.PDAF.omi_assimilate_3dvar() or pyPDAF.PDAF.omi_assimilate_3dvar_nondiagR().

pyPDAF.PDAF.assimilate_en3dvar_estkf

It is recommended to use pyPDAF.PDAF.omi_assimilate_en3dvar_estkf() or pyPDAF.PDAF.omi_assimilate_en3dvar_estkf_nondiagR().

pyPDAF.PDAF.assimilate_en3dvar_lestkf

It is recommended to use pyPDAF.PDAF.localomi_assimilate_en3dvar_lestkf() or pyPDAF.PDAF.localomi_assimilate_en3dvar_lestkf_nondiagR().

pyPDAF.PDAF.assimilate_hyb3dvar_estkf

It is recommended to use pyPDAF.PDAF.omi_assimilate_hyb3dvar_estkf() or pyPDAF.PDAF.omi_assimilate_hyb3dvar_estkf_nondiagR().

pyPDAF.PDAF.assimilate_hyb3dvar_lestkf

It is recommended to use pyPDAF.PDAF.localomi_assimilate_hyb3dvar_lestkf() or pyPDAF.PDAF.localomi_assimilate_hyb3dvar_lestkf_nondiagR().

pyPDAF.PDAF.assimilate_enkf

It is recommended to use pyPDAF.PDAF.omi_assimilate_global() or pyPDAF.PDAF.omi_assimilate_enkf_nondiagR().

pyPDAF.PDAF.assimilate_estkf

It is recommended to use pyPDAF.PDAF.omi_assimilate_global() or pyPDAF.PDAF.omi_assimilate_global_nondiagR() instead of this function.

pyPDAF.PDAF.assimilate_etkf

It is recommended to use pyPDAF.PDAF.omi_assimilate_global() or pyPDAF.PDAF.omi_assimilate_global_nondiagR().

pyPDAF.PDAF.assimilate_seek

It is recommended to use pyPDAF.PDAF.omi_assimilate_global() or pyPDAF.PDAF.omi_assimilate_global_nondiagR().

pyPDAF.PDAF.assimilate_seik

It is recommended to use pyPDAF.PDAF.omi_assimilate_global() or pyPDAF.PDAF.omi_assimilate_global_nondiagR().

pyPDAF.PDAF.assimilate_netf

It is recommended to use pyPDAF.PDAF.omi_assimilate_global() or pyPDAF.PDAF.omi_assimilate_nonlin_nondiagR().

pyPDAF.PDAF.assimilate_pf

It is recommended to use pyPDAF.PDAF.omi_assimilate_global() or pyPDAF.PDAF.omi_assimilate_nonlin_nondiagR().

pyPDAF.PDAF.assimilate_lenkf

It is recommended to use pyPDAF.PDAF.omi_assimilate_lenkf() or pyPDAF.PDAF.omi_assimilate_lenkf_nondiagR().

pyPDAF.PDAF.assimilate_lestkf

It is recommended to use pyPDAF.PDAF.localomi_assimilate() or pyPDAF.PDAF.localomi_assimilate_nondiagR().

pyPDAF.PDAF.assimilate_letkf

It is recommended to use pyPDAF.PDAF.localomi_assimilate() or pyPDAF.PDAF.localomi_assimilate_nondiagR().

pyPDAF.PDAF.assimilate_lseik

It is recommended to use pyPDAF.PDAF.localomi_assimilate() or pyPDAF.PDAF.localomi_assimilate_nondiagR().

pyPDAF.PDAF.assimilate_lnetf

It is recommended to use pyPDAF.PDAF.localomi_assimilate() or pyPDAF.PDAF.localomi_assimilate_lnetf_nondiagR().

pyPDAF.PDAF.assimilate_lknetf

It is recommended to use pyPDAF.PDAF.localomi_assimilate() or pyPDAF.PDAF.localomi_assimilate_lknetf_nondiagR().

pyPDAF.PDAF.omi_assimilate_local

It is recommended to use pyPDAF.PDAF.localomi_assimilate() or pyPDAF.PDAF.localomi_assimilate_nondiagR(), or pyPDAF.PDAF.localomi_assimilate_lnetf_nondiagR(), or pyPDAF.PDAF.localomi_assimilate_lknetf_nondiagR().

pyPDAF.PDAF.omi_assimilate_en3dvar_lestkf

It is recommended to use pyPDAF.PDAF.localomi_assimilate_en3dvar_lestkf() or pyPDAF.PDAF.localomi_assimilate_en3dvar_lestkf_nondiagR().

pyPDAF.PDAF.omi_assimilate_hyb3dvar_lestkf

It is recommended to use pyPDAF.PDAF.localomi_assimilate_hyb3dvar_lestkf() or pyPDAF.PDAF.localomi_assimilate_hyb3dvar_lestkf_nondiagR().

pyPDAF.PDAF.omi_assimilate_lnetf_nondiagR

It is recommended to use pyPDAF.PDAF.localomi_assimilate_lnetf_nondiagR() or pyPDAF.PDAF.localomi_assimilate().

pyPDAF.PDAF.omi_assimilate_lknetf_nondiagR

It is recommended to use pyPDAF.PDAF.localomi_assimilate_lknetf_nondiagR() or pyPDAF.PDAF.localomi_assimilate().

pyPDAF.PDAF.omi_assimilate_en3dvar_lestkf_nondiagR

It is recommended to use pyPDAF.PDAF.localomi_assimilate_en3dvar_lestkf_nondiagR() or pyPDAF.PDAF.localomi_assimilate_en3dvar_lestkf().

pyPDAF.PDAF.omi_assimilate_hyb3dvar_lestkf_nondiagR

It is recommended to use pyPDAF.PDAF.localomi_assimilate_hyb3dvar_lestkf_nondiagR() or pyPDAF.PDAF.localomi_assimilate_hyb3dvar_lestkf().

pyPDAF.PDAF.local_assimilate_en3dvar_lestkf

It is recommended to use pyPDAF.PDAF.localomi_assimilate_en3dvar_lestkf() or pyPDAF.PDAF.localomi_assimilate_en3dvar_lestkf_nondiagR().

pyPDAF.PDAF.local_assimilate_hyb3dvar_lestkf

It is recommended to use pyPDAF.PDAF.localomi_assimilate_hyb3dvar_lestkf() or pyPDAF.PDAF.localomi_assimilate_hyb3dvar_lestkf_nondiagR().

pyPDAF.PDAF.local_assimilate_lestkf

It is recommended to use pyPDAF.PDAF.localomi_assimilate() or pyPDAF.PDAF.localomi_assimilate_nondiagR().

pyPDAF.PDAF.local_assimilate_letkf

It is recommended to use pyPDAF.PDAF.localomi_assimilate() or pyPDAF.PDAF.localomi_assimilate_nondiagR().

pyPDAF.PDAF.local_assimilate_lseik

It is recommended to use pyPDAF.PDAF.localomi_assimilate() or pyPDAF.PDAF.localomi_assimilate_nondiagR().

pyPDAF.PDAF.local_assimilate_lnetf

It is recommended to use pyPDAF.PDAF.localomi_assimilate() or pyPDAF.PDAF.localomi_assimilate_lnetf_nondiagR().

pyPDAF.PDAF.local_assimilate_lknetf

It is recommended to use pyPDAF.PDAF.localomi_assimilate() or pyPDAF.PDAF.localomi_assimilate_lknetf_nondiagR().

pyPDAF.PDAF.put_state_3dvar

It is recommended to use pyPDAF.PDAF.omi_put_state_3dvar() or pyPDAF.PDAF.omi_put_state_3dvar_nondiagR().

pyPDAF.PDAF.put_state_en3dvar_estkf

It is recommended to use pyPDAF.PDAF.omi_put_state_en3dvar_estkf() or pyPDAF.PDAF.omi_put_state_en3dvar_estkf_nondiagR().

pyPDAF.PDAF.put_state_en3dvar_lestkf

It is recommended to use pyPDAF.PDAF.localomi_put_state_en3dvar_lestkf() or pyPDAF.PDAF.localomi_put_state_en3dvar_lestkf_nondiagR().

pyPDAF.PDAF.put_state_hyb3dvar_estkf

It is recommended to use pyPDAF.PDAF.omi_put_state_hyb3dvar_estkf() or pyPDAF.PDAF.omi_put_state_hyb3dvar_estkf_nondiagR().

pyPDAF.PDAF.put_state_hyb3dvar_lestkf

It is recommended to use pyPDAF.PDAF.localomi_put_state_hyb3dvar_lestkf() or pyPDAF.PDAF.localomi_put_state_hyb3dvar_lestkf_nondiagR().

pyPDAF.PDAF.put_state_enkf

It is recommended to use pyPDAF.PDAF.omi_put_state_global() or pyPDAF.PDAF.omi_put_state_enkf_nondiagR().

pyPDAF.PDAF.put_state_estkf

It is recommended to use pyPDAF.PDAF.omi_put_state_global() or pyPDAF.PDAF.omi_put_state_global_nondiagR() instead of this function.

pyPDAF.PDAF.put_state_etkf

It is recommended to use pyPDAF.PDAF.omi_put_state_global() or pyPDAF.PDAF.omi_put_state_global_nondiagR().

pyPDAF.PDAF.put_state_seek

It is recommended to use pyPDAF.PDAF.omi_put_state_global() or pyPDAF.PDAF.omi_put_state_global_nondiagR().

pyPDAF.PDAF.put_state_seik

It is recommended to use pyPDAF.PDAF.omi_put_state_global() or pyPDAF.PDAF.omi_put_state_global_nondiagR().

pyPDAF.PDAF.put_state_netf

It is recommended to use pyPDAF.PDAF.omi_put_state_global() or pyPDAF.PDAF.omi_put_state_nonlin_nondiagR().

pyPDAF.PDAF.put_state_pf

It is recommended to use pyPDAF.PDAF.omi_put_state_global() or pyPDAF.PDAF.omi_put_state_nonlin_nondiagR().

pyPDAF.PDAF.put_state_lenkf

It is recommended to use pyPDAF.PDAF.omi_put_state_lenkf() or pyPDAF.PDAF.omi_put_state_lenkf_nondiagR().

pyPDAF.PDAF.put_state_lestkf

It is recommended to use pyPDAF.PDAF.localomi_put_state() or pyPDAF.PDAF.localomi_put_state_nondiagR().

pyPDAF.PDAF.put_state_letkf

It is recommended to use pyPDAF.PDAF.localomi_put_state() or pyPDAF.PDAF.localomi_put_state_nondiagR().

pyPDAF.PDAF.put_state_lseik

It is recommended to use pyPDAF.PDAF.localomi_put_state() or pyPDAF.PDAF.localomi_put_state_nondiagR().

pyPDAF.PDAF.put_state_lnetf

It is recommended to use pyPDAF.PDAF.localomi_put_state() or pyPDAF.PDAF.localomi_put_state_lnetf_nondiagR().

pyPDAF.PDAF.put_state_lknetf

It is recommended to use pyPDAF.PDAF.localomi_put_state() or pyPDAF.PDAF.localomi_put_state_lknetf_nondiagR().

pyPDAF.PDAF.omi_put_state_en3dvar_lestkf

It is recommended to use pyPDAF.PDAF.localomi_put_state_en3dvar_lestkf() or pyPDAF.PDAF.localomi_put_state_en3dvar_lestkf_nondiagR().

pyPDAF.PDAF.omi_put_state_hyb3dvar_lestkf

It is recommended to use pyPDAF.PDAF.localomi_put_state_hyb3dvar_lestkf() or pyPDAF.PDAF.localomi_put_state_hyb3dvar_lestkf_nondiagR().

pyPDAF.PDAF.omi_put_state_local

It is recommended to use pyPDAF.PDAF.localomi_put_state() or pyPDAF.PDAF.localomi_put_state_nondiagR(), or pyPDAF.PDAF.localomi_put_state_lnetf_nondiagR(), or pyPDAF.PDAF.localomi_put_state_lknetf_nondiagR().

pyPDAF.PDAF.omi_put_state_lnetf_nondiagR

It is recommended to use pyPDAF.PDAF.localomi_put_state_lnetf_nondiagR() or pyPDAF.PDAF.localomi_put_state().

pyPDAF.PDAF.omi_put_state_lknetf_nondiagR

It is recommended to use pyPDAF.PDAF.localomi_put_state_lknetf_nondiagR() or pyPDAF.PDAF.localomi_put_state().

pyPDAF.PDAF.omi_put_state_en3dvar_lestkf_nondiagR

It is recommended to use pyPDAF.PDAF.localomi_put_state_en3dvar_lestkf_nondiagR() or pyPDAF.PDAF.localomi_put_state_en3dvar_lestkf().

pyPDAF.PDAF.omi_put_state_hyb3dvar_lestkf_nondiagR

It is recommended to use pyPDAF.PDAF.localomi_put_state_hyb3dvar_lestkf_nondiagR() or pyPDAF.PDAF.localomi_put_state_hyb3dvar_lestkf().

pyPDAF.PDAF.local_put_state_en3dvar_lestkf

It is recommended to use pyPDAF.PDAF.localomi_put_state_en3dvar_lestkf() or pyPDAF.PDAF.localomi_put_state_en3dvar_lestkf_nondiagR().

pyPDAF.PDAF.local_put_state_hyb3dvar_lestkf

It is recommended to use pyPDAF.PDAF.localomi_put_state_hyb3dvar_lestkf() or pyPDAF.PDAF.localomi_put_state_hyb3dvar_lestkf_nondiagR().

pyPDAF.PDAF.local_put_state_lestkf

It is recommended to use pyPDAF.PDAF.localomi_put_state() or pyPDAF.PDAF.localomi_put_state_nondiagR().

pyPDAF.PDAF.local_put_state_letkf

It is recommended to use pyPDAF.PDAF.localomi_put_state() or pyPDAF.PDAF.localomi_put_state_nondiagR().

pyPDAF.PDAF.local_put_state_lseik

It is recommended to use pyPDAF.PDAF.localomi_put_state() or pyPDAF.PDAF.localomi_put_state_nondiagR().

pyPDAF.PDAF.local_put_state_lnetf

It is recommended to use pyPDAF.PDAF.localomi_put_state() or pyPDAF.PDAF.localomi_put_state_lnetf_nondiagR().

pyPDAF.PDAF.local_put_state_lknetf

It is recommended to use pyPDAF.PDAF.localomi_put_state() or pyPDAF.PDAF.localomi_put_state_lknetf_nondiagR().

+
+
+ + +
+ +
+
+ +
+
+
+ ©2022 University of Reading and National Centre for Earth Observation. + + | + Powered by Sphinx 8.0.2 + & Alabaster 1.0.0 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_autosummary/pyPDAF.PDAF.diag_CRPS_nompi.html b/docs/_autosummary/pyPDAF.PDAF.diag_CRPS_nompi.html new file mode 100644 index 00000000..1e44ff81 --- /dev/null +++ b/docs/_autosummary/pyPDAF.PDAF.diag_CRPS_nompi.html @@ -0,0 +1,165 @@ + + + + + + + + pyPDAF.PDAF.diag_CRPS_nompi — pyPDAF documentation + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

pyPDAF.PDAF.diag_CRPS_nompi

+
+
+pyPDAF.PDAF.diag_CRPS_nompi()
+

Obtain a continuous rank probability score for an ensemble without using MPI parallelisation. The implementation is based on This function follows follows Hersbach, H., 2000: Decomposition of the Continuous Ranked Probability Score for Ensemble Prediction Systems. Wea. Forecasting, 15, 559–570, https://doi.org/10.1175/1520-0434(2000)015<0559:DOTCRP>2.0.CO;2

+
+
Parameters:
+
    +

  • element (int) – ID of element to be used +If element=0, mean values over all elements are computed

    • +

  • oens (ndarray[tuple[dim, dim_ens], np.float64]) –

    State ensemble

    +

    The 1st-th dimension dim is PE-local state dimension +The 2nd-th dimension dim_ens is Ensemble size

    +

    • +

  • obs (ndarray[tuple[dim], np.float64]) –

    State ensemble

    +

    The array dimension dim is PE-local state dimension

    +

    • +
+
+
Returns:
+

    +

  • CRPS (float) – CRPS

    • +

  • reli (float) – Reliability

    • +

  • resol (float) – resolution

    • +

  • uncert (float) – uncertainty

    • +

  • status (int) – Status flag (0=success)

    • +
+

+
+
+
+ +
+ + +
+ +
+
+ +
+
+
+ ©2022 University of Reading and National Centre for Earth Observation. + + | + Powered by Sphinx 8.0.2 + & Alabaster 1.0.0 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_sources/API_legacy.rst.txt b/docs/_sources/API_legacy.rst.txt new file mode 100644 index 00000000..cca8e197 --- /dev/null +++ b/docs/_sources/API_legacy.rst.txt @@ -0,0 +1,84 @@ +API (legacy) +============ +.. contents:: + :local: + :depth: 2 + +DA algorithms +------------- +.. autosummary:: + :toctree: _autosummary + :recursive: + + pyPDAF.PDAF.assimilate_3dvar + pyPDAF.PDAF.assimilate_en3dvar_estkf + pyPDAF.PDAF.assimilate_en3dvar_lestkf + pyPDAF.PDAF.assimilate_hyb3dvar_estkf + pyPDAF.PDAF.assimilate_hyb3dvar_lestkf + pyPDAF.PDAF.assimilate_enkf + pyPDAF.PDAF.assimilate_estkf + pyPDAF.PDAF.assimilate_etkf + pyPDAF.PDAF.assimilate_seek + pyPDAF.PDAF.assimilate_seik + pyPDAF.PDAF.assimilate_netf + pyPDAF.PDAF.assimilate_pf + pyPDAF.PDAF.assimilate_lenkf + pyPDAF.PDAF.assimilate_lestkf + pyPDAF.PDAF.assimilate_letkf + pyPDAF.PDAF.assimilate_lseik + pyPDAF.PDAF.assimilate_lnetf + pyPDAF.PDAF.assimilate_lknetf + + pyPDAF.PDAF.omi_assimilate_local + pyPDAF.PDAF.omi_assimilate_en3dvar_lestkf + pyPDAF.PDAF.omi_assimilate_hyb3dvar_lestkf + + pyPDAF.PDAF.omi_assimilate_lnetf_nondiagR + pyPDAF.PDAF.omi_assimilate_lknetf_nondiagR + pyPDAF.PDAF.omi_assimilate_en3dvar_lestkf_nondiagR + pyPDAF.PDAF.omi_assimilate_hyb3dvar_lestkf_nondiagR + + pyPDAF.PDAF.local_assimilate_en3dvar_lestkf + pyPDAF.PDAF.local_assimilate_hyb3dvar_lestkf + pyPDAF.PDAF.local_assimilate_lestkf + pyPDAF.PDAF.local_assimilate_letkf + pyPDAF.PDAF.local_assimilate_lseik + pyPDAF.PDAF.local_assimilate_lnetf + pyPDAF.PDAF.local_assimilate_lknetf + + pyPDAF.PDAF.put_state_3dvar + pyPDAF.PDAF.put_state_en3dvar_estkf + pyPDAF.PDAF.put_state_en3dvar_lestkf + pyPDAF.PDAF.put_state_hyb3dvar_estkf + pyPDAF.PDAF.put_state_hyb3dvar_lestkf + pyPDAF.PDAF.put_state_enkf + pyPDAF.PDAF.put_state_estkf + pyPDAF.PDAF.put_state_etkf + pyPDAF.PDAF.put_state_seek + pyPDAF.PDAF.put_state_seik + pyPDAF.PDAF.put_state_netf + pyPDAF.PDAF.put_state_pf + pyPDAF.PDAF.put_state_lenkf + pyPDAF.PDAF.put_state_lestkf + pyPDAF.PDAF.put_state_letkf + pyPDAF.PDAF.put_state_lseik + pyPDAF.PDAF.put_state_lnetf + pyPDAF.PDAF.put_state_lknetf + + pyPDAF.PDAF.omi_put_state_en3dvar_lestkf + pyPDAF.PDAF.omi_put_state_hyb3dvar_lestkf + pyPDAF.PDAF.omi_put_state_local + + pyPDAF.PDAF.omi_put_state_lnetf_nondiagR + pyPDAF.PDAF.omi_put_state_lknetf_nondiagR + pyPDAF.PDAF.omi_put_state_en3dvar_lestkf_nondiagR + pyPDAF.PDAF.omi_put_state_hyb3dvar_lestkf_nondiagR + + pyPDAF.PDAF.local_put_state_en3dvar_lestkf + pyPDAF.PDAF.local_put_state_hyb3dvar_lestkf + pyPDAF.PDAF.local_put_state_lestkf + pyPDAF.PDAF.local_put_state_letkf + pyPDAF.PDAF.local_put_state_lseik + pyPDAF.PDAF.local_put_state_lnetf + pyPDAF.PDAF.local_put_state_lknetf + diff --git a/docs/_sources/_autosummary/pyPDAF.PDAF.diag_CRPS_nompi.rst.txt b/docs/_sources/_autosummary/pyPDAF.PDAF.diag_CRPS_nompi.rst.txt new file mode 100644 index 00000000..ee9f9d5b --- /dev/null +++ b/docs/_sources/_autosummary/pyPDAF.PDAF.diag_CRPS_nompi.rst.txt @@ -0,0 +1,6 @@ +pyPDAF.PDAF.diag\_CRPS\_nompi +============================= + +.. currentmodule:: pyPDAF.PDAF + +.. autofunction:: diag_CRPS_nompi \ No newline at end of file