Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

Recent Releases of RavenPy

RavenPy - v0.20.0

New features

  • Updated raven-hydro to v0.5.0 (RavenHydroFramework v4.1.0). (PR #560)
  • ravenpy now officially supports Python 3.14. (PR #577)

Fixes

  • Fix Reservoir command parser failing when optional fields were missing. (PR #544)
  • Add GaugedSubBasinGroup command to RVH class. (Issue #546, PR #547)
  • In nc_specs, set dim_names_nc in the order expected by Raven (x, y, t). Previously, we only made sure that time was the last dimension, but did not ensure x and y were in the right order. (PR #533)
  • Adjusted the Perform_a_climate_change_impact_study_on_a_watershed.ipynb notebook to reduce the number of years in the simulation to speed up execution time. (PR #535)
  • Adjusted a broken test that was overlooked in the previous release (from changes in PR #513). (PR #535)
  • Adapted code base to the pandas v3.0 API. (Issue #570, PR #572)
  • Addressed a small pydantic v2.12 deprecation. (PR #577)
  • Include NetCDFAttribute alias in emulated models. Include dict update logic higher up in the chain rather than only through the emulators field_validator. (PR #580)

Internal changes

  • Updated the cookiecutter template to the latest version (PR #548):
    • Updated the Contributor Covenant Agreement to v3.0.
    • Added a CITATION.cff file.
    • Removed black, blackdoc, and isort, as well as their configurations.
    • Updated pyproject.toml to be PEP 639-compliant.
  • Pinned pydantic below v2.12 due to breaking changes in their API. (PR #548)
    • Unpinned pydantic as newer 2.12 patch releases appear to have addressed regressions. (PR #559)
  • Pinned pydap >=3.5.6 and h5netcdf >=1.5.0 to ensure modern versions with better xarray support are installed by default. (PR #559)
  • Updated the cookiecutter template to the latest version (PR #569):
    • Added a workflow for automatically accepting and merging periodic updates from Dependabot affecting CI dependencies.
  • Added a pytest fixture to perform a teardown of changes performed within the installed ravenpy source location. (PR #572)

Hydrosphere - Freshwater and Hydrology - Python
Published by github-actions[bot] 4 months ago

RavenPy - v0.19.1

Breaking changes

  • scipy is no longer pinned below v1.16.0, as newer statsmodels is now compatible with modern scipy versions. (PR #524)
  • black and isort have been replaced with ruff for code formatting and linting. This change simplifies the development workflow and improves code consistency. (PR #525).

Internal changes

  • Updates the notebooks and re-runs all of them to ensure they are working with latest libraries. (PR #524)
  • Adds a few missing testing data files to the pooch registry.txt file that are necessary for running the notebooks. (PR #524)
  • Slightly adjusted CI workflows for security and behaviour improvements. (PR #524)
  • Obsolete support code for handling older owslib versions has been removed from ravenpy.utilities.geoserver. (PR #525).
  • Code formatting and linting rules have been modified to use the newer ruff configurations. The formatting changes have been effected in the entire codebase. (PR #525).

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre 10 months ago

RavenPy - v0.19.0

New features

  • Added parsers.parse_rv to extract a Command value from an RV file. (PR #503)
  • New module ravenpy.testing has been added to provide utility functions and support for testing and testing data management. (PR #513)

Breaking changes

  • ravenpy now requires pooch>=1.8.0 for downloading and caching remote testing data. (PR #513)
  • ravenpy.utilities.testdata has been refactored to new module ravenpy.testing. The publish_release_notes function is now located in ravenpy.utilities.publishing. (PR #513)
  • The ravenpy.testing.utils module now provides a yangtze() class for fetching and caching the raven-testdata testing data. A convenience function (get_file) replaces the previous get_local_testdata. (PR #513)
  • The ravenpy.testing.utils.open_dataset function no longer supports OPeNDAP URLs or local file paths. Instead, it uses the yangtze() class to fetch datasets from the testing data repository or the local cache. Users should now use xarray.open_dataset() directly for OPeNDAP URLs or local files. (PR #513)

Bug fixes

  • Fixed bug affecting GriddedForcing, where station_idx in the call to nc_specs was set to 1 instead of None. (PR #501)
  • Fixed bug in the run method, where overwrite=False was not being respected. (PR #503)
  • Pin scipy below v1.16.0 due to a breaking change that affects statsmodels below v0.14.4. (PR #521)

Internal changes

  • ravenpy now requires xclim>=0.57.0 and xsdba (v0.4.0+). (PR #511)
  • The tests folder no longer contains an __init__.py file and is no longer treated as a package. pytest fixtures from emulators.py are now directly imported into conftest.py for use in tests, and existing pytest fixtures have been modified to use the new yangtze() class for fetching testing data. (PR #513)

Hydrosphere - Freshwater and Hydrology - Python
Published by github-actions[bot] 11 months ago

RavenPy - v0.18.2

New features

  • Added RelativeHumidityMethod to RVIs. (PR #490).
  • Add parse methods to LineCommand, SubBasins, HRUs, Reservoir, SubBasinGroup, ChannelProfile. (PR #492).
  • Tweak the GridWeightExtractor to support datasets from the Canadian River and Lake Hydrofabric. Allows setting the routing_id_field to __INDEX__ in order to match HRU IDs. (PR #492).
  • Add support for Recharge process. (PR #492).

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre about 1 year ago

RavenPy - v0.18.1

New features

  • ravenpy no longer installs raven-hydro by default. The Raven model executable can now be provided by explicitly setting the RAVENPY_RAVEN_BINARY_PATH environment variable. (PR #486).

Bug fixes

  • Fixed a bug in ravenpy.utilities.regionalization.multiple_linear_regression that was calling a class method incorrectly. (PR #484).

Internal changes

  • pydap has been pinned below v3.5.5 temporarily until xarray offers support for it. (PR #486).
  • More than 7500 DeprecationWarnings emitted during the testing suite have been addressed. Minimum supported pydantic has been raised to v2.11. (PR #487).
  • Regenerated the notebook outputs using newer version of xclim. (PR #484).

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre about 1 year ago

RavenPy - v0.18.0

New features

  • ravenpy now supports Python3.13. (PR #459)
  • Updated raven-hydro to v0.4.0 (RavenHydroFramework v4.0.1). (PR #459)
  • Updated xclim to v0.54.0, pint to v0.24.4, and numpy to v1.24.0 (no longer pinned below v2.0). (PR #459)
  • ravenpy is now registered with the Open Source Security Foundation (OSSF) Best Practices initiative (RavenPy OpenSSF-BP Status). (PR #464)
  • ravenpy now enables new EvaluationMetrics commands in the model configuration. Other features from RavenHydroFramework will be included in newer releases. (PR #476)

Bug fixes

  • Fix bug in _MonthlyRecord class definition crashing the pydantic-autodoc serialization. (PR #458)
  • Fixed a small API bug in the Comparing_hindcasts_and_ESP_forecasts.ipynb notebook. (PR #463)
  • The Raven model previously always reported version "3.7", regardless of the installed Raven version. It now uses raven-hydro's __raven_version__ attribute. (PR #464)

Internal changes

  • Updated the cookiecutter template to the latest commit: (PR #454)
    • GitHub Actions and Python dependencies have been updated.
    • New pre-commit hooks for vulture (find dead code) and codespell (spelling errors).
    • Removed several type: ignore statements.
    • Spelling errors in documentation have been addressed.
  • GitHub Workflows now test ravenpy using macOS as well as Python3.13. (PR #459)
  • Several small deprecation and usage warnings as well as a few variable typing issues have been addressed. (PR #464)
  • Updated the license to reflect current year. (PR #476)
  • Documentation version now supports showing hyphens in the version number. (PR #476)
  • Call signatures and docstrings of functions have been modified to be more precise for the expected variable type. (PR #476)

Hydrosphere - Freshwater and Hydrology - Python
Published by github-actions[bot] about 1 year ago

RavenPy - v0.17.0

  • Updated the cookiecutter template to the latest commit and synchronized dependencies between PyPI and Anaconda recipes. (PR #427)
  • Updated ts_fit_graph logic for matplotlib >= 3.10.0 compatibility. (PR #434)
  • Temporarily pinned pygments below v2.19 due to a breaking change affecting sphinx-codeautolink. (PR #434)
  • Adopted a new RavenPy logo for the documentation. (PR #428)
  • Documentation Updates: (PR #436)
    • Cleaner imports, removed some unneeded library imports.
    • Typo and grammar fixes.
    • Updated the Python, Anaconda, and Ubuntu versions used to generate the documentation.
  • Small import fixes and minor code cleanup (ravenpy.extractors). (PR #436)
  • Adjusted pins for intake, intake-esm and zarr to ensure notebooks run correctly. (PR #440)
  • Added a Security Policy (SECURITY.md) to the repository. (PR #441)
  • Updated the cookiecutter template to the latest commit: (PR #444)
    • Workflows now use Checkout with persist-credentials: false.
    • CodeQL workflow has been updated.
    • pre-commit hooks for vulture (finding dead code) and zizmor (finding security vulnerabilities) have been added.

Hydrosphere - Freshwater and Hydrology - Python
Published by github-actions[bot] over 1 year ago

RavenPy - v0.16.1

What's Changed

Full Changelog: https://github.com/CSHS-CWRA/RavenPy/compare/v0.16.0...v0.16.1

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre over 1 year ago

RavenPy - v0.16.0

What's Changed

New Contributors

Full Changelog: https://github.com/CSHS-CWRA/RavenPy/compare/v0.15.0...v0.16.0

Hydrosphere - Freshwater and Hydrology - Python
Published by github-actions[bot] over 1 year ago

RavenPy - v0.15.0

What's Changed

Full Changelog: https://github.com/CSHS-CWRA/RavenPy/compare/v0.14.1...v0.15.0

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre almost 2 years ago

RavenPy - v0.13.1

This is a patch update of v0.13.0 containing a backport of the following changes in order to provide stability for PAVICS users:

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre about 2 years ago

RavenPy - v0.14.1

What's Changed

Full Changelog: https://github.com/CSHS-CWRA/RavenPy/compare/v0.14.0...v0.14.1

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre about 2 years ago

RavenPy - v0.14.0

What's Changed

New Contributors

Full Changelog: https://github.com/CSHS-CWRA/RavenPy/compare/v0.13...v0.14.0

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre about 2 years ago

RavenPy - v0.13

What's Changed

Full Changelog: https://github.com/CSHS-CWRA/RavenPy/compare/v0.12.3...v0.13

Hydrosphere - Freshwater and Hydrology - Python
Published by huard over 2 years ago

RavenPy - v0.12.3

What's Changed

Full Changelog: https://github.com/CSHS-CWRA/RavenPy/compare/v0.12.2...v0.12.3

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre over 2 years ago

RavenPy - v0.12.2

What's Changed

Full Changelog: https://github.com/CSHS-CWRA/RavenPy/compare/v0.12.1...v0.12.2

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre almost 3 years ago

RavenPy - v0.12.1

What's Changed

Full Changelog: https://github.com/CSHS-CWRA/RavenPy/compare/v0.12.0...v0.12.1

Hydrosphere - Freshwater and Hydrology - Python
Published by huard about 3 years ago

RavenPy - v0.12.0

What's Changed

This release includes major breaking changes. It completely overhauls how models are defined, and how to run
simulations. Code relying on the previous release will most likely break. Please check the documentation
to see how to use the new improved interface.

New Contributors

Full Changelog: https://github.com/CSHS-CWRA/RavenPy/compare/v0.11.0...v0.12.0

Hydrosphere - Freshwater and Hydrology - Python
Published by huard about 3 years ago

RavenPy - v0.11.0

What's Changed

Full Changelog: https://github.com/CSHS-CWRA/RavenPy/compare/v0.10.0...v0.11.0

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre over 3 years ago

RavenPy - v0.10.0

What's Changed

Full Changelog: https://github.com/CSHS-CWRA/RavenPy/compare/v0.9.0...v0.10.0

Hydrosphere - Freshwater and Hydrology - Python
Published by huard over 3 years ago

RavenPy - v0.9.0

Breaking changes

  • HRUState's signature has changed. Instead of passing variables as keyword arguments (e.g. soil0=10.), it now expects a state dictionary keyed by variables' Raven name (e.g. {"SOIL[0]": 10}). This change makes rvc` files easier to read, and avoids Raven warnings regarding 'initial conditions for state variables not in model'.
  • nc_index renamed to meteo_idx to enable the specification of distinct indices for observed streamflow using hydro_idx. nc_index remains supported for backward compatibility.
  • The distributed python testing library, pytest-xdist is now a testing and development requirement.
  • xarray has been pinned below "2022.11.0" due to incompatibility with climpred=="2.2.0".

New features

  • Add support for hydrometric gauge data distinct from meteorological input data. Configuration parameter hydro_idx identifies the gauge station index, while meteo_idx (previously nc_index) stands for the meteo station index.
  • Add support for multiple gauge observations. If a list of hydro_idx is provided, it must be accompanied with a list of corresponding subbasin identifiers (gauged_sb_ids) of the same length.
  • Automatically infer scale and offset :LinearTransform parameters from netCDF file metadata, so that input data units are automatically converted to Raven-compliant units whenever possible.
  • Add support for the command :RedirectToFile. Tested for grid weights only.
  • Add support for the command :WriteForcingFunctions.
  • Add support for the command :CustomOutput.
  • Multiple other new RavenCommand objects added, but not integrated in the configuration, including :SoilParameterList, :VegetationParameterList and :LandUseParameterList.
  • Multichoice options (e.g. calendars) moved from RV classes to config.options, but aliases created for backward compatibility.
  • Patch directory traversal vulnerability (CVE-2007-4559 <https://github.com/advisories/GHSA-gw9q-c7gh-j9vm>_).
  • A local copy of the raven-testdata with environment variable (RAVENPY_TESTDATA_PATH) set to that location is now no longer needed in order to run the testing suite. Test data is fetched automatically and now stored at ~/.raven_testing_data.
  • RavenPy now leverages pytest-xdist to distribute tests among Python workers and significantly speed up the testing suite, depending on number of available CPUs. File access within the testing suite has also been completely rewritten for thread safety.
    • On pytest launch with "--numprocesses > 0", testing data will be fetched automatically from Ouranosinc/raven-testdata by one worker, blocking others until this step is complete. Spawned pytest workers will then copy the testing data to their respective temporary directories before beginning testing.
  • To aid with development and debugging purposes, two new environment variables and pytest fixtures are now available:
    • In order to skip the data collection step: export SKIP_TEST_DATA=true
    • In order to target a specific branch of Ouranosinc/raven-testdata for data retrieval: export MAIN_TESTDATA_BRANCH="my_branch"
    • In order to fetch testing data using the user-set raven-testdata branch, pytest fixtures for get_file and get_local_testdata are now available for convenience

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre over 3 years ago

RavenPy - v0.8.1

Reverts the change in 0.8.0 regarding suppress_output, as it breaks downstream applications.
Slowdown due to build-up of files in zip archive handled by not calling parse_results during calibration.

Hydrosphere - Freshwater and Hydrology - Python
Published by huard over 3 years ago

RavenPy - v0.8.0

Breaking changes:

  • Parallel parameters must be provided explicitly using the parallel argument when calling emulators.
  • Multiple nc_index values generate multiple gauges, instead of being parallelized.
  • Python3.7 is no longer supported.
  • Documentation now uses sphinx-apidoc at build-time to generate API pages.

Other changes:

  • Add generate-hrus-from-routing-product script.
  • Do not write RV zip file and merge outputs when suppress_output is True. Zipping rv files during multiple calibration runs leads to a non-linear performance slow-down.
  • Fixed issues with coverage reporting via tox and GitHub Actions

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre over 3 years ago

RavenPy - v0.7.8

  • Added functionalities in Data Assimilation utils and simplified tests.
  • Removed pin on setuptools.
  • Fixed issues related to symlinks, working directory, and output filenames.
  • Fixed issues related to GDAL version handling in conda-forge.
  • Updated jupyter notebooks.

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre over 4 years ago

RavenPy - v0.7.7

  • Updated internal shapely calls to remove deprecated .to_wkt() methods.

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre over 4 years ago

RavenPy - v0.7.6

  • Automate release pipeline to PyPI using GitHub CI actions.
  • Added coverage monitoring GitHub CI action.
  • Various documentation adjustments.
  • Various metadata adjustments.
  • Pinned owslib to 0.24.1 and above.
  • Circumvented a bug in GitHub CI that was causing tests to fail at collection stage.

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre over 4 years ago

RavenPy - v0.7.5

  • Update test so that it works with xclim 0.29.

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre over 4 years ago

RavenPy - v0.7.4

  • Pinned climpred below v2.1.6

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre over 4 years ago

RavenPy - v0.7.3

  • Pinned xclim below v0.29.0

Hydrosphere - Freshwater and Hydrology - Python
Published by Zeitsperre almost 5 years ago

RavenPy - v0.7.2

  • Update cruft
  • Subclass derived_parameters in Ostrich emulators to avoid having to pass params.

Hydrosphere - Freshwater and Hydrology - Python
Published by huard almost 5 years ago

RavenPy - v0.7.0

  • Add support for V2.1 of the Routing Product in ravenpy.extractors.routing_product.
  • Add collect-subbasins-upstream-of-gauge CLI script.
  • Modify WFS request functions to use spatial filtering (Intersects) supplied by OWSLib.

Hydrosphere - Freshwater and Hydrology - Python
Published by cjauvin almost 5 years ago

RavenPy - v0.6.0

  • Add support for EvaluationPeriod commands. Note that as a result of this, the model's diagnostics property contains one list per key, instead of a single scalar. Also note that for calibration, Ostrich will use the first period and the first evaluation metric.
  • Add SACSMA, CANADIANSHIELD and HYPR model emulators.

Hydrosphere - Freshwater and Hydrology - Python
Published by cjauvin almost 5 years ago

RavenPy - v0.5.2

  • Simplify RVC configuration logic.
  • Add ravenpy.utilities.testdata.file_md5_checksum (previously in xarray.tutorial).

Hydrosphere - Freshwater and Hydrology - Python
Published by cjauvin about 5 years ago

RavenPy - v0.5.1

  • Some adjustments and bugfixes needed for RavenWPS
  • Refactoring of some internal logic in ravenpy.config.rvs.RVT
  • Improvements to typing with the help of mypy

Hydrosphere - Freshwater and Hydrology - Python
Published by cjauvin about 5 years ago

RavenPy - v0.5.0

  • Refactoring of the RV config subsystem
    • The config is fully encapsulated into its own class: ravenpy.config.rvs.Config
    • The emulator RV templates are inline in their emulator classes
  • The emulators have their own submodule: ravenpy.models.emulators
  • The "importers" have been renamed to "extractors" and they have their own submodule: ravenpy.extractors

Hydrosphere - Freshwater and Hydrology - Python
Published by cjauvin about 5 years ago

RavenPy - v0.4.2

  • Update to Raven revision 318 to fix OPENDAP access for StationForcing commands
  • Fix problems with defaults for grid_weights and nc_index
  • Pass nc_index to ObservationData command
  • Expose more cleanly RavenC errors and warnings
  • Add test with Canopex and fix related bugs
  • Remove nbstripout hook
  • Replace a broken notebook by one demoing how to access Canopex data.

Hydrosphere - Freshwater and Hydrology - Python
Published by huard about 5 years ago

RavenPy - v.0.4.1

  • Add notebook about hindcast verification skill.
  • Add notebook about routing capability.
  • Modify geoserver functions to have them return GeoJSON instead of GML.
  • Collect upstream watershed aggregation logic.
  • Fix RVC bug.

Hydrosphere - Freshwater and Hydrology - Python
Published by cjauvin about 5 years ago

RavenPy - v0.4.0

This is an interim version making one step toward semi-distributed modeling support. Model configuration is still in flux and will be significantly modified with 0.5. The major change in this version is that model configuration supports passing multiple HRU objects, instead of simply passing area, latitude, longitude and elevation for a single HRU.

  • GR4JCN emulator now supports routing mode.
  • Add BLENDED model emulator.
  • DAP links for forcing files are now supported.
  • Added support for tox-based localized installation and testing with python-pip.
  • Now supporting Python 3.7, 3.8, and 3.9.
  • Build testing for pip and conda-based builds with GitHub CI.

Hydrosphere - Freshwater and Hydrology - Python
Published by huard about 5 years ago

RavenPy - v0.3.0

  • Migration and refactoring of GIS and IO utilities (utils.py, utilities/gis.py) from RavenWPS to RavenPy.
  • RavenPy can now be installed from PyPI without GIS dependencies (limited functionality).
  • Hydro routing product is now supported from geoserver.py (a notebook has been added to demonstrate the new functions).
  • New script ravenpy aggregate-forcings-to-hrus to aggregate NetCDF files and compute updated grid weights.
  • Add the basis for a new routing emulator option (WIP).
  • Add climpred verification capabilities.

Hydrosphere - Freshwater and Hydrology - Python
Published by cjauvin about 5 years ago

RavenPy - v0.2.3

  • Regionalisation data is now part of the package.
  • Fix tests that were not using testdata properly.
  • Add tests for external dataset access.
  • utilities.testdata.get_local_testdata now raises an exception when it finds no dataset corresponding to the user pattern.

Hydrosphere - Freshwater and Hydrology - Python
Published by cjauvin over 5 years ago

RavenPy - v0.2.2

  • Set wcs.getCoverage timeout to 120 seconds.
  • Fix Raven.parse_results logic when no flow observations are present and no diagnostic file is created.
  • Fix ECCC test where input was cached and shadowed forecast input data.

Hydrosphere - Freshwater and Hydrology - Python
Published by cjauvin over 5 years ago

RavenPy - v0.2.1

  • Fix xarray caching bug in ravenpy.utilities.regionalization

Hydrosphere - Freshwater and Hydrology - Python
Published by cjauvin over 5 years ago

RavenPy - v0.2.0

  • Refactoring of ravenpy.utilities.testdata functions
  • Bump xclim to 0.23

Hydrosphere - Freshwater and Hydrology - Python
Published by cjauvin over 5 years ago