Merge pull request #85 from DHI/fix_warnings_of_compatibility_with_ot…

…her_packages

Fix warnings of compatibility with other packages

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## [Unreleased]
 
+## [2025.0.1] - 2025-02-12
+
+### Added
+- Better compatibility warnings for MIKE IO and MIKE IO 1D.
+- Override of compatibiltiy warnings with environment variable "MIKEPLUSPY_DISABLE_CONFLICT_CHECKS"
+
+### Added
+- Support for MIKE+ 2025.
+
 ## [2025.0.0] - 2025-11-28
 
 ### Added

README.md

@@ -36,6 +36,15 @@ The version of MIKE+Py you install must match the version of MIKE+ installed on
 ## Examples
 Please check out our [collection of jupyter notebooks] (https://github.com/DHI/mikepluspy/tree/main/notebooks) to get started with MIKE+Py.
 
+## Known issues
+
+There's currently a known issue of using MIKE+Py together with MIKE IO and MIKE IO 1D.  We are working on fixing this and appreciate your patience.
+
+Workarounds:
+* Importing MIKE IO 1D *after* MIKE+Py will work.
+* Using Python's multiprocessing library to split imports (and workflows) into separate processes.
+* Split MIKE IO  and MIKE+Py / MIKE IO 1D workflows into separate scripts.
+
 ## Where can I get help?
 * Bugs - [GitHub Issues](https://github.com/DHI/mikepluspy/issues)
 * Feature requests - [GitHub Issues](https://github.com/DHI/mikepluspy/issues) 

mikeplus/__init__.py

@@ -1,6 +1,10 @@
-import clr
+__version__ = "2025.0.1"
 
-__version__ = "2025.0.0"
+from .conflicts import check_conflicts
+
+check_conflicts()
+
+import clr  # noqa: E402
 
 clr.AddReference(
     "DHI.Mike.Install, Version=1.0.0.0, Culture=neutral, PublicKeyToken=c513450b5d0bf0bf"

mikeplus/conflicts.py

@@ -0,0 +1,36 @@
+"""Provides useful warnings about conflicts related to usage alongside mikeio and mikeio1d."""
+
+import sys
+import os
+
+MIKEIO1D_IMPORTED_BEFORE_MIKEPLUS = "mikeio1d" in sys.modules
+DISABLE_CONFLICT_CHECKS = (
+    os.getenv("MIKEPLUSPY_DISABLE_CONFLICT_CHECKS", "false").lower() == "true"
+)
+
+
+def check_conflicts():
+    """Check for conflicts with mikeio and mikeio1d.
+
+    This function checks if mikeio1d was imported before mikeplus. If so, it raises an error
+    that mikeio1d must be imported after mikeplus.
+
+    It also checks if mikeio is imported. If so, it raises an error that mikeio cannot currently
+    be used in same process as mikeplus.
+    """
+
+    if DISABLE_CONFLICT_CHECKS:
+        return
+
+    if MIKEIO1D_IMPORTED_BEFORE_MIKEPLUS:
+        raise ImportError(
+            "mikeio1d must be imported after mikeplus to avoid conflicts. See docs for more info."
+        )
+
+    if "mikeio" in sys.modules:
+        raise ImportError(
+            """mikeio cannot currently be used in same process as mikeplus. 
+            Workarounds include splitting code into separate scripts or using 
+            Python's multiprocessing library to import mikeio and mikeplus in 
+            separate processes. See docs for more info."""
+        )

mikeplus/datatableaccess.py

@@ -17,6 +17,7 @@
 from .dotnet import as_dotnet_list
 from .dotnet import from_dotnet_datetime
 from .dotnet import to_dotnet_datetime
+from .conflicts import check_conflicts
 from datetime import datetime
 from warnings import warn
 
@@ -64,7 +65,7 @@ def __repr__(self):
 
     def open_database(self):
         """Open database"""
-        self._check_conflict()
+        check_conflicts()
         if self.is_database_open():
             return
         data_source = BaseDataSource.Create(self._file_path)
@@ -351,21 +352,6 @@ def is_database_open(self):
         )
         return is_open
 
-    def _check_conflict(self):
-        """Check if there are conflicts with mikeio and mikeioid"""
-
-        mike1dio = sys.modules.get("mikeio1d")
-        if mike1dio is not None:
-            raise RuntimeError(
-                "mikeio1d module has been loaded. mikeio1d only can be loaded after mikeplus module."
-            )
-
-        mikeio = sys.modules.get("mikeio")
-        if mikeio is not None:
-            raise RuntimeError(
-                "mikeplus cannot currently be used with mikeio in the same script."
-            )
-
     def _create_datatables(self):
         datatables = DataTableContainer(True)
         return datatables

pyproject.toml

@@ -7,7 +7,7 @@ exclude = ["notebooks", "tests"]
 
 [project]
 name = "mikeplus"
-version = "2025.0.0"
+version = "2025.0.1"
 dependencies = [
     "numpy",
     'pythonnet>=3.0',