Pydaymet

-------------------

Breaking Changes
~~~~~~~~~~~~~~~~
- Remove caching-related arguments from all functions since now they
can be set globally via three environmental variables:

* ``HYRIVER_CACHE_NAME``: Path to the caching SQLite database.
* ``HYRIVER_CACHE_EXPIRE``: Expiration time for cached requests in seconds.
* ``HYRIVER_CACHE_DISABLE``: Disable reading/writing from/to the cache file.

You can do this like so:

.. code-block:: python

import os

os.environ["HYRIVER_CACHE_NAME"] = "path/to/file.sqlite"
os.environ["HYRIVER_CACHE_EXPIRE"] = "3600"
os.environ["HYRIVER_CACHE_DISABLE"] = "true"

-------------------

New Features
~~~~~~~~~~~~
- Add a new flag to both ``get_bycoords`` and ``get_bygeom`` functions
called ``snow`` which separates snow from the precipitation using
the `Martinez and Gupta (2010) <https://doi.org/10.1029/2009WR008294>`__ method.

Internal Changes
~~~~~~~~~~~~~~~~
- Add elevation data when computing PET regardless of the ``pet`` method.
- Match the chunk size of ``elevation`` with that of the climate data.
- Drop ``time`` dimension from ``elevation``, ``lon``, and ``lat`` variables.

Bug Fixes
~~~~~~~~~
- Fix a bug in setting dates for monthly timescales. For monthly timescale
Daymet calendar is at 15th or 16th of the month, so input dates need to be
adjusted accordingly.

-------------------

Internal Changes
~~~~~~~~~~~~~~~~
- Clean up the PET computation functions' output by removing temporary
variables that are created during the computation.
- Add more attributes for ``elevation`` and ``pet`` variables.
- Add type checking with ``typeguard`` and fixed typing issues raised by
``typeguard``.
- Refactor ``show_versions`` to ensure getting correct versions of all
dependencies.

-------------------

Internal Changes
~~~~~~~~~~~~~~~~
- Use the three new ``ar.retrieve_*`` functions instead of the old ``ar.retrieve``
function to improve type hinting and to make the API more consistent.

-------------------

New Features
~~~~~~~~~~~~
- Expose the ``ssl`` argument for disabling the SSL certification verification (:issue_day:`41`).
Now, you can pass ``ssl=False`` to disable the SSL verification in both ``get_bygeom`` and
``get_bycoord`` functions. Moreover, you can pass ``--disable_ssl`` to PyDaymet's command line
interface to disable the SSL verification.

Breaking Changes
~~~~~~~~~~~~~~~~
- Set the request caching's expiration time to never expire. Add two flags to all
functions to control the caching: ``expire_after`` and ``disable_caching``.

Internal Changes
~~~~~~~~~~~~~~~~
- Add all the missing types so ``mypy --strict`` passes.

-------------------

Internal Changes
~~~~~~~~~~~~~~~~
- Use ``importlib-metadata`` for getting the version instead of ``pkg_resources``
to decrease import time as discussed in this
`issue <https://github.com/pydata/xarray/issues/5676>`__.