Changeset 6f951ca in flex_extract.git for source/python/mods/disaggregation.py

Timestamp:

Jan 15, 2019, 1:05:10 AM (5 years ago)

Author:

Anne Philipp <anne.philipp@…>

Branches:

master, ctbto, dev

Children:

d4696e0

Parents:

2625ca8

Message:

new style of docstring params and updates in docstrings

File:

• source/python/mods/disaggregation.py (modified) (8 diffs)

source/python/mods/disaggregation.py

@@ -17 +17 @@
 #        - outsourced the disaggregation functions dapoly and darain
 #          to a new module named disaggregation
+#        - added the new disaggregation method for precipitation
 #
 # @License:
-#    (C) Copyright 2015-2018.
-#
-#    This software is licensed under the terms of the Apache Licence Version 2.0
-#    which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
-#
-# @Module Description:
-#    disaggregation of deaccumulated flux data from an ECMWF model FG field.
-#    Initially the flux data to be concerned are:
-#    - large-scale precipitation
-#    - convective precipitation
-#    - surface sensible heat flux
-#    - surface solar radiation
-#    - u stress
-#    - v stress
-#    Different versions of disaggregation is provided for rainfall
-#    data (darain, modified linear) and the surface fluxes and
-#    stress data (dapoly, cubic polynomial).
-#
-# @Module Content:
+#    (C) Copyright 2014-2019.
+#    Anne Philipp, Leopold Haimberger
+#
+#    This work is licensed under the Creative Commons Attribution 4.0
+#    International License. To view a copy of this license, visit
+#    http://creativecommons.org/licenses/by/4.0/ or send a letter to
+#    Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
+#
+# @Methods:
 #    - dapoly
 #    - darain
 #    - IA3
-#
 #*******************************************************************************
+'''Disaggregation of deaccumulated flux data from an ECMWF model FG field.
+
+Initially the flux data to be concerned are:
+    - large-scale precipitation
+    - convective precipitation
+    - surface sensible heat flux
+    - surface solar radiation
+    - u stress
+    - v stress
+
+Different versions of disaggregation is provided for rainfall
+data (darain, modified linear) and the surface fluxes and
+stress data (dapoly, cubic polynomial).
+'''
 
 # ------------------------------------------------------------------------------
@@ -65 +69 @@
     Parameters
     ----------
-    alist : :obj:`list` of :obj:`array` of :obj:`float`
+    alist : list of array of float
         List of 4 timespans as 2-dimensional, horizontal fields.
         E.g. [[array_t1], [array_t2], [array_t3], [array_t4]]
@@ -71 +75 @@
     Return
     ------
-    nfield : :obj:`array` of :obj:`float`
+    nfield : array of float
         Interpolated flux at central point of accumulation timespan.
 
@@ -109 +113 @@
     Parameters
     ----------
-    alist : :obj:`list` of :obj:`array` of :obj:`float`
+    alist : list of array of float
         List of 4 timespans as 2-dimensional, horizontal fields.
         E.g. [[array_t1], [array_t2], [array_t3], [array_t4]]
@@ -115 +119 @@
     Return
     ------
-    nfield : :obj:`array` of :obj:`float`
+    nfield : array of float
         Interpolated flux at central point of accumulation timespan.
 
@@ -160 +164 @@
     Note
     ----
-    Copyright 2017
+    (C) Copyright 2017-2019
     Sabine Hittmeir, Anne Philipp, Petra Seibert
 
@@ -170 +174 @@
     Parameters
     ----------
-    g : :obj:`list` of :obj:`float`
+    g : list of float
         Complete data series that will be interpolated having
         the dimension of the original raw series.
@@ -176 +180 @@
     Return
     ------
-    f : :obj:`list` of :obj:`float`
+    f : list of float
         The interpolated data series with additional subgrid points.
         Its dimension is equal to the length of the input data series