Release/1.1.0 (#133)

* Prepare for version bump

* Update to version 1.1

* Update whats-new.rst and remove unused parameters

* Update data.rst

* Update setup.py

Author: arbennett

docs/configuration.rst

@@ -76,6 +76,11 @@ account when simulating incoming shortwave radiation.  Defaults to ``0``.
 ``mtclim_swe_corr :: bool``: Whether to activate MtClim's SWE correction
 algorithm. Default to ``False``.
 
+``utc_offset :: bool``: Whether to use UTC timecode offsets for shifting
+timeseries. Without this option all times should be considered local to
+the gridcell being processed. Large domain runs probably want to set this
+option to ``True``.
+
 ``lw_cloud :: str``: Type of cloud correction to longwave radiation to apply.
 Can be either ``DEFAULT`` or ``CLOUD_DEARDORFF``.  Defaults to
 ``CLOUD_DEARDORFF``.  Capitalization does not matter.

docs/data.rst

@@ -35,29 +35,26 @@ Second, is the ``elev`` variable. This provides elevation data used for
 calculation of solar geometry. It should be specified in meters, and only needs
 to be given at sites which are marked to be processed via the ``mask`` variable.
 
-It is important to ensure that all valid locations in ``mask`` have data in 
+It is important to ensure that all valid locations in ``mask`` have data in
 ``elev``.  Failure to ensure this will result in errors during runtime.
 
 State file
 ----------
 The state file provides information about the history of each of the grid cells
 to be processed. There are four required variables.
 
-The first two are daily minimum and daily maximum temperatures for the 90 days 
-preceeding the start date specified in the configuration file.  They should be 
-specified as ``t_min`` and ``t_max`` respectively. Similarly precipitation 
-should be given as ``prec``.  These variables are used to generate seasonal 
+The first two are daily minimum and daily maximum temperatures for the 90 days
+preceeding the start date specified in the configuration file.  They should be
+specified as ``t_min`` and ``t_max`` respectively. Similarly precipitation
+should be given as ``prec``.  These variables are used to generate seasonal
 averages which are used in the calculation of shortwave and longwave radiation.
 
-The final required variable is the initial snow water equivalent (SWE) for each
-grid cell. It should be named ``swe`` in the file.
-
 Output Specifications
 =====================
 .. ATTENTION::
-    The ``time`` coordinate in MetSim's output is local to the location of each 
-    cell! This means that for a single time slice in the NetCDF file all locations
-    along a parallel (same latitude) will have the same solar geometry at that time.
+    The ``time`` coordinate in MetSim's output is local to the location of each cell unless the ``utc_offset`` is set to
+    ``True``! This means that for a single time slice in the NetCDF file all locations along a parallel (same latitude)
+    will have the same solar geometry at that time.
 
 The output variables that are available are dependent on the time step being used.  There are two cases:
 
@@ -71,11 +68,11 @@ step:
 * ``t_min`` : Minimum temperature (also a required input value) (C)
 * ``t_max`` : Maximum temperature (also a required input value) (C)
 * ``prec`` : Precipitation (also a required input value) (mm/day)
-* ``swe`` : Snow water equivalent (mm)
 * ``vapor_pressure`` : Vapor pressure (kPa)
 * ``shortwave`` : Shortwave radiation (W/m^2)
 * ``tskc`` : Cloud cover fraction
 * ``pet`` : Potential evapotranpiration (mm/day)
+* ``wind`` : Wind speed (only if given as an input) (m/s)
 
 Sub-daily Output
 ----------------

docs/examples.rst

@@ -51,7 +51,6 @@ contents are:
     prec = prec
     t_max = t_max
     t_min = t_min
-    swe = swe
 
     [domain_vars]
     lat = lat

docs/whats-new.rst

@@ -21,6 +21,9 @@ Enhancements
   going to be used by MtClim. (:issue:`103`). By `Joe Hamman <https://github.com/jhamman>`_.
 - Added support for supplying a glob-like file path or multiple input forcing
   files (netCDF) (:issue:`126`). By `Joe Hamman <https://github.com/jhamman>`_.
+- Refactored ``mtclim`` and ``disaggregate`` functions to reduce interdependency and
+  increase modularity. By `Andrew Bennett <https://github.com/arbennett>`_.
+- Removed ``swe`` calculations. By `Andrew Bennett <https://github.com/arbennett>`_.
 
 Bug fixes
 ~~~~~~~~~
@@ -31,3 +34,6 @@ Bug fixes
   Added a clear error message explaining that subdaily timesteps must be evenly
   divisible into 24 hours and less than 6 hours in length. (:issue:`110`).
   By `Joe Hamman <https://github.com/jhamman>`_.
+- Fixed a bug during disaggregation when ``t_min > t_max``.  This now raises
+  an exception.
+  By `Andrew Bennett <https://github.com/arbennett>`_.

environment.yml

@@ -9,3 +9,5 @@ dependencies:
   - numba
   - numpy=1.11.2
   - scipy=0.18.1
+  - dask
+  - toolz

metsim/cli/ms renamed to metsim/cli/ms.py

@@ -38,20 +38,20 @@ def disaggregate(df_daily: pd.DataFrame, params: dict,
 
     Parameters
     ----------
-    df_daily: pd.DataFrame
+    df_daily:
         Dataframe containing daily timeseries.
         Should be the result of one of the methods
         provided in the `methods` directory.
-    params: dict
+    params:
         A dictionary containing the class parameters
         of the MetSim object.
-    solar_geom: dict
+    solar_geom:
         A dictionary of solar geometry variables
-    t_begin: list
+    t_begin:
         List of t_min and t_max for day previous to the
         start of `df_daily`. None indicates no extension
         of the record.
-    t_end: list
+    t_end:
         List of t_min and t_max for day after the end
         of `df_daily`. None indicates no extension of
         the record.
@@ -119,16 +119,19 @@ def set_min_max_hour(tiny_rad_fract: np.array, yday: np.array, n_days: int,
 
     Parameters
     ----------
-    disagg_rad:
-        Shortwave radiation disaggregated
-        to sub-daily timesteps.
+    tiny_rad_fract:
+        Array of fraction of shortwave radiation received
+        at a shortened timestep. This should be calculated
+        by `metsim.physics.solar_geom`.
+    yday:
+        Array of day of year for each simulated day.
     n_days:
-        The number of days being disaggregated
+        Number of days in run.
     ts:
-        Timestep used for disaggregation
+        Timestep of run.
     params:
-        A dictionary of class parameters of
-        the MetSim object.
+        Dictionary of parameters to use.  Must contain
+        `utc_offset` and `tmax_daylength_fraction`.
 
     Returns
     -------
@@ -173,11 +176,12 @@ def temp(t_min: np.array, t_max: np.array, out_len: int,
 
     Parameters
     ----------
-    TODO: FIXME
-    df_daily:
-        A dataframe of daily values.
-    df_disagg:
-        A dataframe of sub-daily values.
+    t_min:
+        Timeseries of daily minimum temperatures.
+    t_max:
+        Timeseries of daily maximum temperatures.
+    out_len:
+        Length of the required output vector.
     t_t_min:
         Times at which minimum daily
         temperatures are reached.
@@ -186,11 +190,11 @@ def temp(t_min: np.array, t_max: np.array, out_len: int,
         temperatures are reached.
     ts:
         Timestep for disaggregation
-    t_begin: list
+    t_begin:
         List of t_min and t_max for day previous to the
         start of `df_daily`. None indicates no extension
         of the record.
-    t_end: list
+    t_end:
         List of t_min and t_max for day after the end
         of `df_daily`. None indicates no extension of
         the record.

metsim/disaggregate.py

@@ -128,8 +128,6 @@ class MetSim(object):
         "lw_type": 'prata',
         "tdew_tol": 1e-6,
         "tmax_daylength_fraction": 0.67,
-        "snow_crit_temp": -6.0,
-        "snow_melt_rate": 0.042,
         "rain_scalar": 0.75,
         "tday_coef": 0.45,
         "lapse_rate": 0.0065,

metsim/metsim.py

@@ -9,13 +9,13 @@
       cmdclass=versioneer.get_cmdclass(),
       description='Meteorology Simulator',
       url='https://github.com/UW-Hydro/MetSim',
-      download_url='https://github.com/UW-Hydro/MetSim/archive/v1.0.tar.gz',
       author='Andrew Bennett',
       author_email='[email protected]',
       packages=['metsim', 'metsim.methods', 'metsim.cli'],
       entry_points={
           'console_scripts': ['ms = metsim.cli.ms:main']},
-      install_requires=['xarray', 'numba'],
+      install_requires=['xarray', 'numba', 'numpy', 'pandas',
+                        'dask', 'toolz', 'netCDF4', 'scipy'],
       keywords=['meteorology', 'disaggregation', 'hydrology',
                 'climate', 'mtclim'],
       tests_require=['pytest'],)