Changes That Break Backward Compatibility

Version 25.1 (unreleased)

The following changes that were introduced in version 25.1 of the tools repository are incompatible with earlier versions:

  • The minimum supported version of Python is 3.11. Development of the SalishSeaTools package is done using Python 3.13.

  • The erddapy package is now a required dependency to use the evaltools module. The recommended way to add erddapy to your activated salishsea-tools environment is with the command conda env update -f SalishSeaTools/envs/environment-dev.yaml

  • The variables argument has been dropped from the evaltools.load_ferry_ERDDAP() and evaltools.load_ONC_node_ERDDAP() functions because custom variables selection was not fully implemented.

  • Support for atmospheric forcing data matching has been removed from the evaltools.matchData() function. A ValueError is now raised if maskName="ops".

  • mesh_mask_path is now a required argument for the evaltools.matchData() function. The mesh_mask_path argument was previously called meshPath. Requiring a mesh mask path ensures that the user can specify the correct mesh mask for the model version that they are matching data to instead of possibly using an incorrect mesh mask by default.

  • The sdim argument of the evaltools.matchData() function has been changed to n_spatial_dims to make its meaning more evident.

  • The preIndexed argument of the evaltools.matchData() function has been changed to pre_indexed to make it consistent with Python variable naming style.

  • The fdict argument of the evaltools.matchData() function has been changed to model_file_hours_res to make its meaning more evident.

  • The filemap argument of the evaltools.matchData() function has been changed to model_var_file_types to make its meaning more evident.

  • The maskName argument of the evaltools.matchData() function has been changed to mask_name to make it consistent with Python variable naming style.

  • The fastSearch argument of the evaltools.matchData() function has been changed to fast_search_index_path. Its value has changed from a boolean to at string containing the path and file name of a high-resolution lon/lat to grid index mapping to use to speed up matching; e.g. "~/MEOPAR/grid/grid_from_lat_lon_mask999.nc". This ensures that the user can specify the correct index mapping for the model version that they are matching data to. If no index mapping is provided, salishsea_tools.geo_tools.find_closest_model_point() is used to calculate the model grid indices for the observation data lons/lats.

Version 24.1 (2025-01-09)

The following changes that were introduced in version 24.1 of the tools repository are incompatible with earlier versions:

  • Removed docs and package stub for SalishSeaNowcast package. It was moved into its own repository in late-2016.

  • Removed docs and package stub for SalishSeaCmd package. It was moved into its own repository in late-2016.

  • Changed to CalVer versioning convention. Version identifier format is now yy.n[.devn], where yy is the (post-2000) year of release, and n is the number of the release within the year, starting at 1. After a release has been made the value of n is incremented by 1, and .dev0 is appended to the version identifier to indicate changes that will be included in the next release. 24.1.dev0 is an exception to that scheme. That version identifies the period of development between the 2.0 and 24.1 releases.