From 472f1b452876852f517c54c8e79b31d391bb1076 Mon Sep 17 00:00:00 2001 From: Joeri van Engelen Date: Fri, 20 Dec 2024 13:42:00 +0100 Subject: [PATCH] Issue #1362 rename release tag (#1363) Fixes #1362 # Description - Rename 1.0.0b0 to 1.0.0rc0 - Fix some other missing methods in public API and changelog --- docs/api/changelog.rst | 42 ++++++++++++++++++++++-------------------- docs/api/mf6.rst | 2 ++ docs/installation.rst | 6 +++--- imod/__init__.py | 2 +- pixi.toml | 2 +- 5 files changed, 29 insertions(+), 25 deletions(-) diff --git a/docs/api/changelog.rst b/docs/api/changelog.rst index 3fef3efc4..28a7fca01 100644 --- a/docs/api/changelog.rst +++ b/docs/api/changelog.rst @@ -6,7 +6,7 @@ All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog`_, and this project adheres to `Semantic Versioning`_. -[1.0.0b0] - 2024-12-20 +[1.0.0rc0] - 2024-12-20 ---------------------- Added @@ -34,26 +34,27 @@ Added Fixed ~~~~~ -- Fixed bug where :class:`HorizontalFlowBarrierResistance`, - :class:`HorizontalFlowBarrierSingleLayerResistance` and other HFB packages - could not be allocated to cell edges when idomain in layer 1 was largely - inactive. +- Fixed bug where :class:`imod.mf6.HorizontalFlowBarrierResistance`, + :class:`imod.mf6.HorizontalFlowBarrierSingleLayerResistance` and other HFB + packages could not be allocated to cell edges when idomain in layer 1 was + largely inactive. - Fixed bug where :meth:`HorizontalFlowBarrierResistance.clip_box`, :meth:`HorizontalFlowBarrierSingleLayerResistance.clip_box` methods only returned deepcopy instead of actually clipping the line geometries. -- Fixed bug where :class:`HorizontalFlowBarrierResistance`, - :class:`HorizontalFlowBarrierSingleLayerResistance` and other HFB packages could not - be clipped or copied with xarray >= 2024.10.0. +- Fixed bug where :class:`imod.mf6.HorizontalFlowBarrierResistance`, + :class:`imod.mf6.HorizontalFlowBarrierSingleLayerResistance` and other HFB + packages could not be clipped or copied with xarray >= 2024.10.0. - Fixed crash upon calling :meth:`imod.mf6.GroundwaterFlowModel.dump`, when a - :class:`HorizontalFlowBarrierResistance`, - :class:`HorizontalFlowBarrierSingleLayerResistance` or other HFB package was - assigned to the model. + :class:`imod.mf6.HorizontalFlowBarrierResistance`, + :class:`imod.mf6.HorizontalFlowBarrierSingleLayerResistance` or other HFB + package was assigned to the model. - :meth:`imod.mf6.Modflow6Simulation.regrid_like` can now regrid a structured model to an unstructured grid. - :meth:`imod.mf6.Modflow6Simulation.regrid_like` throws a ``NotImplementedError`` when attempting to regrid an unstructured model to a structured grid. -- :class:`imod.msw.Sprinkling` now correctly writes source svats to scap_svat.inp file. +- :class:`imod.msw.Sprinkling` now correctly writes source svats to + scap_svat.inp file. - :func:`imod.evaluate.calculate_gxg`, upon providing a head dataarray chunked over time, will no longer error with ``ValueError: Object has inconsistent chunks along dimension bimonth. This can be fixed by calling unify_chunks().`` @@ -70,8 +71,8 @@ Changed - If ``"cap"`` package present in ``imod5_data``, :meth:`imod.mf6.GroundwaterFlowModel.from_imod5_data` now automatically adds a well for metaswap sprinkling named ``"msw-sprinkling"`` -- Less strict validation for :class:`HorizontalFlowBarrierResistance`, - :class:`HorizontalFlowBarrierSingleLayerResistance` and other HFB packages for +- Less strict validation for :class:`imod.mf6.HorizontalFlowBarrierResistance`, + :class:`imod.mf6.HorizontalFlowBarrierSingleLayerResistance` and other HFB packages for simulations which are imported with :meth:`imod.mf6.Modflow6Simulation.from_imod5_data` - DeprecationWarning thrown upon initializing :class:`imod.prepare.Regridder`. @@ -87,9 +88,9 @@ Changed Added ~~~~~ -- :class:`imod.prepare.topsystem.SimulationAllocationOptions`, - :class:`imod.prepare.topsystem.SimulationDistributingOptions`, which are used - to store default allocation and distributing options respectively. +- :class:`imod.prepare.SimulationAllocationOptions`, + :class:`imod.prepare.SimulationDistributingOptions`, which are used to store + default allocation and distributing options respectively. Fixed ~~~~~ @@ -150,7 +151,8 @@ Changed - :class:`imod.mf6.Well` now also validates that well filter top is above well filter bottom -- :func:`open_projectfile_data` now also imports well filter top and bottom. +- :func:`imod.formats.prj.open_projectfile_data` now also imports well filter + top and bottom. - :class:`imod.mf6.Well` now logs a warning if any wells are removed during writing. - :class:`imod.mf6.HorizontalFlowBarrierResistance`, :class:`imod.mf6.HorizontalFlowBarrierMultiplier`, @@ -160,8 +162,8 @@ Changed :func:`imod.prepare.linestring_to_square_zpolygons` and :func:`imod.prepare.linestring_to_trapezoid_zpolygons` to generate these polygons. -- :func:`open_projectfile_data` now returns well data grouped by ipf name, - instead of generic, separate number per entry. +- :func:`imod.formats.prj.open_projectfile_data` now returns well data grouped + by ipf name, instead of generic, separate number per entry. - :class:`imod.mf6.Well` now supports wells which have a filter with zero length, where ``"screen_top"`` equals ``"screen_bottom"``. - :class:`imod.mf6.Well` shares the same default ``minimum_thickness`` as diff --git a/docs/api/mf6.rst b/docs/api/mf6.rst index 6510d5509..711275c7b 100644 --- a/docs/api/mf6.rst +++ b/docs/api/mf6.rst @@ -12,6 +12,7 @@ Read Output open_hds open_cbc read_cbc_headers + open_dvs Model objects & methods ----------------------- @@ -124,6 +125,7 @@ Flow Packages NodePropertyFlow.clip_box Recharge Recharge.from_imod5_data + Recharge.from_imod5_cap_data Recharge.mask Recharge.regrid_like Recharge.clip_box diff --git a/docs/installation.rst b/docs/installation.rst index 3297bd200..993d59f86 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -28,15 +28,15 @@ Install beta release To install a beta release with pixi:: - pixi add imod=1.0.0b0 + pixi add imod=1.0.0rc0 Or with conda:: - conda install imod=1.0.0b0 + conda install imod=1.0.0rc0 Or with pip:: - pip install --pre imod=1.0.0b0 + pip install --pre imod=1.0.0rc0 Which Python? diff --git a/imod/__init__.py b/imod/__init__.py index bd6eab9d9..fea9d8717 100644 --- a/imod/__init__.py +++ b/imod/__init__.py @@ -15,4 +15,4 @@ ) from imod.formats import gen, idf, ipf, prj, rasterio -__version__ = "1.0.0b0" +__version__ = "1.0.0rc0" diff --git a/pixi.toml b/pixi.toml index 52423ac62..457032d55 100644 --- a/pixi.toml +++ b/pixi.toml @@ -1,6 +1,6 @@ [project] name = "imod-python" -version = "1.0.0b0" +version = "1.0.0rc0" description = "Make massive MODFLOW models" authors = ["Deltares "] channels = ["conda-forge"]