Skip to content

FloPy 3.5.0

Compare
Choose a tag to compare
@github-actions github-actions released this 26 Nov 00:23
· 192 commits to master since this release
879c153

Version 3.5.0


⚠️ Breaking changes

  • rno, iuzno, lakeno, wellno attributes were standardized to ifno (for "feature number") — a 3.5.x patch may provide backwards-compatibility as this was released somewhat prematurely

Highlights

Python 3.12 support

While previous releases may be compatible with Python 3.12, this release adds official support. Note: the wheel for pyzmq, a core dependency of IPython/jupyter, may fail to build when installing optional dependencies via e.g. pip install "flopy[test]" or pip install "flopy[optional]". To work with notebooks in the meantime Conda is recommended.

Pandas integration
  • Promote Pandas from optional to core dependency (note pandas >= 2 is required)
  • Reimplement MF6 internal data storage with Pandas — may provide significant speedups reading/writing MF6 input files. To fall back to the old implementation, set use_pandas=False on MFSimulation.load() or at init time.
  • Support DataFrame for flopy.modflow.* package input data, e.g. node_data and stress_period_data
Deprecations

Several deprecated features are removed or turned into errors:

  • sr property from Mt3dms
  • flopy.export.vtk functions export_model(), export_package(), export_transient(), export_heads(), export_array(), export_cbc()
  • flopy.plot.plotutil functions centered_specific_discharge(), cvfd_to_patch_collection(), plot_cvfd()
  • layer kwarg in MFTransientArray's get_data() method
  • MFSimulation functions get_mvr_file(), get_mvt_file(), get_gnc_file(), get_ims_package()
  • nwt_11_fmt parameter from ModflowUzf1 initializer
  • Grid.thick and .saturated_thick properties
Other changes
  • rno, iuzno, lakeno, wellno standardized to ifno (for "feature number")

Several features are newly deprecated:

  • ra_slice() from flopy.utils.recarray_utils, suggest numpy.lib.recfunctions.repack_fields()
  • recarray() from flopy.utils.recarray_utils, suggest numpy.core.records.fromrecords()
  • epsg, proj4, and proj4_str are replaced with a single crs parameter on MF6 Grid and ModflowDis classes and various utilities
  • branch option for flopy.mf6.utils.generate_classes utility replaced with ref

See specific commits below for more info on suggested replacements.


New features

Bug fixes

Refactoring