enh: move frequency module to public API

cerfacs-globc · Mar 26, 2024 · 747d926 · 747d926
1 parent 43e9f09
commit 747d926
Show file tree

Hide file tree

Showing 23 changed files with 983 additions and 742 deletions.
diff --git a/doc/source/references/api/icclim/_core/frequency/index.rst b/doc/source/references/api/icclim/_core/frequency/index.rst
@@ -215,12 +215,12 @@ Module Contents
 
    Build timedelta from a "pandas frequency" string.
 
-   A "pandas frequency" string may look like ["2AS-DEC", "3W-TUE", "M", ... ]
-   The anchor, such as "DEC" in "AS-DEC", does not modify the delta.
+   A "pandas frequency" string may look like ["2YS-DEC", "3W-TUE", "M", ... ]
+   The anchor, such as "DEC" in "YS-DEC", does not modify the delta.
 
    :param pandas_freq:
    :type pandas_freq: str
    :param The frequency query.:
 
    :returns: * *The timedelta corresponding to this frequency.*
-             * *For example, "2AS-DEC" would return a 2 years delta.*
+             * *For example, "2YS-DEC" would return a 2 years delta.*
diff --git a/doc/source/references/api/icclim/dcsc/index.rst b/doc/source/references/api/icclim/dcsc/index.rst
@@ -42,37 +42,37 @@ Package Contents
     .. Documentation below is auto-generated with the extract-icclim-funs.py script
     .. Generated API comment:Begin
 
-    tav
-    txav
-    trav
-    tx10
-    tx90
-    tn10
-    tn90
-    tnfd
-    txfd
-    sd
-    tx35
-    tr
-    txnd
-    tnht
-    tnnd
-    tncwd
-    txhwd
-    hdd
-    cdd
-    pav
-    pint
-    rr
-    rr1mm
-    pn20mm
-    pxcdd
-    pxcwd
-    r99
-    pfl90
-    pq90
-    pq99
-    ffav
-    ff98
+     tav
+     txav
+     trav
+     tx10
+     tx90
+     tn10
+     tn90
+     tnfd
+     txfd
+     sd
+     tx35
+     tr
+     txnd
+     tnht
+     tnnd
+     tncwd
+     txhwd
+     hdd
+     cdd
+     pav
+     pint
+     rr
+     rr1mm
+     pn20mm
+     pxcdd
+     pxcwd
+     r99
+     pfl90
+     pq90
+     pq99
+     ffav
+     ff98
 
 .. Generated API comment:End
diff --git a/doc/source/references/api/icclim/ecad/index.rst b/doc/source/references/api/icclim/ecad/index.rst
@@ -40,69 +40,69 @@ Package Contents
 
     .. Documentation below is auto-generated with the extract-icclim-funs.py script
     .. Generated API comment:Begin
-    tg
-    tn
-    tx
-    dtr
-    etr
-    vdtr
-    su
-    tr
-    wsdi
-    tg90p
-    tn90p
-    tx90p
-    txx
-    tnx
-    csu
-    gd4
-    fd
-    cfd
-    hd17
-    id
-    tg10p
-    tn10p
-    tx10p
-    txn
-    tnn
-    csdi
-    cdd
-    prcptot
-    rr1
-    sdii
-    cwd
-    rr
-    r10mm
-    r20mm
-    rx1day
-    rx5day
-    r75p
-    r75ptot
-    r95p
-    r95ptot
-    r99p
-    r99ptot
-    sd
-    sd1
-    sd5cm
-    sd50cm
-    cd
-    cw
-    wd
-    ww
-    fxx
-    fg6bft
-    fgcalm
-    fg
-    ddnorth
-    ddeast
-    ddsouth
-    ddwest
-    gsl
-    spi6
-    spi3
-    pp
-    ss
-    rh
+      tg
+     tn
+     tx
+     dtr
+     etr
+     vdtr
+     su
+     tr
+     wsdi
+     tg90p
+     tn90p
+     tx90p
+     txx
+     tnx
+     csu
+     gd4
+     fd
+     cfd
+     hd17
+     id
+     tg10p
+     tn10p
+     tx10p
+     txn
+     tnn
+     csdi
+     cdd
+     prcptot
+     rr1
+     sdii
+     cwd
+     rr
+     r10mm
+     r20mm
+     rx1day
+     rx5day
+     r75p
+     r75ptot
+     r95p
+     r95ptot
+     r99p
+     r99ptot
+     sd
+     sd1
+     sd5cm
+     sd50cm
+     cd
+     cw
+     wd
+     ww
+     fxx
+     fg6bft
+     fgcalm
+     fg
+     ddnorth
+     ddeast
+     ddsouth
+     ddwest
+     gsl
+     spi6
+     spi3
+     pp
+     ss
+     rh
 
 .. Generated API comment:End
diff --git a/doc/source/references/icclim_index_api.rst b/doc/source/references/icclim_index_api.rst
@@ -178,8 +178,8 @@ Additionally, you can define a season between two exact dates:
 
    With 5.3.0 icclim now accepts pandas string frequency for slice_mode
    to resample the output data to a given frequency There are multiple
-   combinations possible such as: "2AS-FEB" to resample data on two (2)
-   years (A) starting (S) in February (FEB). For further information,
+   combinations possible such as: "2YS-FEB" to resample data on two (2)
+   years (Y) starting (S) in February (FEB). For further information,
    refer to pandas `offset aliases
    <https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases>`_.
 

diff --git a/doc/source/tutorials/index.rst b/doc/source/tutorials/index.rst
@@ -19,3 +19,4 @@ capabilities. To see how icclim can solve specific issues see
    notebooks/custom_freezing_tas
    notebooks/cold_spell_duration
    notebooks/su_summer_days__subset_and_plot
+   notebooks/DCSC_txnn