surface-water-network

This is primarily a maintenance release with no exciting features.

• Require FloPy 3.3.6 or later (#80)
• Accommodate different reach index names rno or ifno since FloPy 3.5.0 (#83)
• Maintenance updates to work with the latest pandas and FloPy releases (#91)
• Update swn.file.gdf_to_shapefile() to keep number data types (#79)

Released 25 May 2023

Breaking changes

• Minimum requirements are Python 3.8, geopandas 0.9 (#58, #69)
• Remove legacy modflow.MfSfrNetwork (#56)

New things

• Add swn.file.read_formatted_frame() and write_formatted_frame() methods (#62, #73)
• Add functionality to allow other MF6 packages to use reaches data with modflow.SwnMf6.package_period_frame(), write_package_period(), flopy_package_period(), and set_package_obj() (#72)
• Add functionality to allow other MODFLOW packages to use reaches data with modflow.SwnModflow.package_period_frame(), write_package_period(), flopy_package_period(), and set_package_obj() (#74)

Other changes

• Better from_swn_flopy performance (#57)
• Change swn.spatial.find_location_pairs() adding all_pairs and exclude_branches parameters (#68)

Deprecations

• swn.spatial.get_sindex() (#58)
• swn.spatial.wkt_to_dataframe(), swn.spatial.wkt_to_geodataframe(), swn.spatial.wkt_to_geoseries() (#70)

Released 20 July 2022

Breaking changes

• Minimum requirements are Python 3.7, pandas 1.2 (#38)
• Add outside segnum to modflow if it is downstream from others (#50)
• Change behaviour of SurfaceWaterNetwork.set_diversions() which by default will now match to the closest segment line (#52)

New things

• Add SurfaceWaterNetwork.locate_geoms() method (#41, #48, #51)
• Add run option to topnet2ts(), improve error messages (#44)
• Add routing methods: SurfaceWaterNetwork.route_segnums(), modflow.SwnModflow.route_reaches(), and modflow.SwnMf6.route_reaches() (#45)
• Add spatial module functions: find_location_pairs() and location_pair_geoms() (#46)
• Add methods modflow.SwnModflow.get_location_frame_reach_info() and modflow.SwnMf6.get_location_frame_reach_info() (#49)
• Implement diversions for MODFLOW6 (#54)

Other changes

• Add packing dependency to check package version (#37)
• Convert class attributes to properties for modflow.SwnModflow.segment_data and segment_data_ts (#42)
• Convert class attributes to properties for modflow.SwnMf6.segments, diversions, and reaches (#43)
• Rename SurfaceWaterNetwork.query() → gather_segnums(); show DeprecationWarning with former method (#47)
• Move project metadata to pyproject.toml, add a few optional dependencies (#53)

Released 20 October 2021

Breaking changes

• Change SurfaceWaterNetwork(lines.geometry) → SurfaceWaterNetwork.from_lines(lines.geometry)
• Change MfSfrNetwork(n, m, ...) → SwnModflow.from_swn_flopy(n, m)
• Legacy modflow.MfSfrNetwork kept, but will be dropped by version 0.6

New things

• Add .to_pickle() and .from_pickle() methods to core classes
• Support MODFLOW 6 models with modflow.SwnMf6 (#12)
• Add SurfaceWaterNetwork.segments_series() and pair_segments_frame() methods (#15)
• Add methods for setting stream bed elevations (#27)
• Add compat module for compatibility
• Add Sphinx documentation, with doctests (#18)

Other changes

• Improve performance of SurfaceWaterNetwork.from_lines() (#33)
• Add mult multiplier to topnet2ts()
• Use declarative configuration for project setup, remove setup.py (#35)