From 1aa771b880bdd8ebb2a493efa91b31944d2d459f Mon Sep 17 00:00:00 2001 From: Ryan Murray <74630349+rywm-dhi@users.noreply.github.com> Date: Fri, 26 Jan 2024 12:47:09 +0100 Subject: [PATCH 1/3] Update README for 2024 experimental release. --- README.md | 38 +++++++++++++++++++++++++------------- 1 file changed, 25 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index bf47658..95e252c 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,36 @@ -# MIKE+ Script: Python script to access mike+ data, engines and tools +# MIKE+ PY: automate your workflows. -For read res1d and xns11 files, please use mikeio1d(https://github.com/DHI/mikeio1d). +MIKE+ PY is a python interface for MIKE+. Its main features include: +* Modifying the MIKE+ database in a way that is consistent with the GUI. +* Run different kinds of simulations (e.g. MIKE 1D, EPANET, SWMM) +* Access certain GUI tools pythonically (e.g. import/export tool). -For other MIKE files (Dfs0, Dfs1, Dfs2, Dfsu,...) use the related package [MIKE IO](https://github.com/DHI/mikeio) +> [!CAUTION] +> MIKE+ PY is experimental and under development. +> * Be aware that there may be bugs or unexpected behavior - use with caution. +> * Always make copies of your MIKE+ databases and verify the outcome of scripts. +> * If you encounter any issues or have any feedback, please report them on [GitHub Issues](https://github.com/DHI/mikeplus-python/issues). ## Requirements +* MIKE+ 2024 (or greater) with valid license +* Python x64 3.8 to 3.12 * Windows operating system -* Python x64 3.6, 3.7 or 3.8 -* Python.Net 3.0 or above - -## Where can I get help? -* General help, new ideas and feature requests - [GitHub Discussions](http://github.com/DHI/mikeio/discussions) -* Bugs - [GitHub Issues](https://github.com/DHI/mikeplus-python/issues) ## Installation -Please install MIKE+ 2024 software first. -From PyPI: +The version of MIKE+ PY you install must match the version of MIKE+ installed on your desktop. + +> [!NOTE] +> MIKE+ PY is not yet available on PyPI since it is in the initial development stages. + +| MIKE+ Version | Install command| +|:--------------|:---------------| +| MIKE+ 2024 | `pip install https://github.com/DHI/mikeplus-python/archive/refs/tags/v2024.0-latest.zip` | -`pip install mikeplus` ## Examples -Please check the jupyter notebook here: https://github.com/DHI/mikeplus-python/tree/main/notebooks \ No newline at end of file +Please check out the jupyter notebooks here: https://github.com/DHI/mikeplus-python/tree/main/notebooks + +## Where can I get help? +* General help, new ideas and feature requests - [GitHub Discussions](http://github.com/DHI/mikeplus-python/discussions) +* Bugs - [GitHub Issues](https://github.com/DHI/mikeplus-python/issues) \ No newline at end of file From 85047914abf510eddc6b651c10f0aa9fbc2b7a54 Mon Sep 17 00:00:00 2001 From: Ryan Murray <74630349+rywm-dhi@users.noreply.github.com> Date: Fri, 26 Jan 2024 16:45:54 +0100 Subject: [PATCH 2/3] Update change log and version number --- CHANGELOG.md | 10 +++++----- mikeplus/__init__.py | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e2035dc..d4ddd6a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,11 +1,11 @@ -# mikeplus script Changelog +# MIKE+ PY Changelog ## [Unreleased] -## [0.1] - 2023-08-30 +## [2024.0.0] - 2024-01-26 ### Added -- Ability to add query database methods -- Ability to add engine launcher (mike1d and epanet) -- Ability to run some tools +- Ability to read/write MIKE+ database +- Ability to run engines (MIKE 1D, EPANET, SWMM) +- Ability to run some initial tools diff --git a/mikeplus/__init__.py b/mikeplus/__init__.py index 0016686..96f55f5 100644 --- a/mikeplus/__init__.py +++ b/mikeplus/__init__.py @@ -1,6 +1,6 @@ import clr -__version__ = "0.1.0" +__version__ = "2024.0.0" clr.AddReference("DHI.Mike.Install, Version=1.0.0.0, Culture=neutral, PublicKeyToken=c513450b5d0bf0bf") from DHI.Mike.Install import MikeImport, MikeProducts From ee600df5b22dfd40bad81c710e27cc268b3dbbed Mon Sep 17 00:00:00 2001 From: Ryan Murray <74630349+rywm-dhi@users.noreply.github.com> Date: Tue, 30 Jan 2024 07:35:50 +0100 Subject: [PATCH 3/3] Update name to MIKE+Py --- CHANGELOG.md | 4 ++-- README.md | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d4ddd6a..c3ed2ea 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,8 @@ -# MIKE+ PY Changelog +# MIKE+Py Changelog ## [Unreleased] -## [2024.0.0] - 2024-01-26 +## [2024.0.0] - 2024-01-30 ### Added diff --git a/README.md b/README.md index 95e252c..bc7b263 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -# MIKE+ PY: automate your workflows. +# MIKE+Py: automate your workflows. -MIKE+ PY is a python interface for MIKE+. Its main features include: +MIKE+Py is a python interface for MIKE+. Its main features include: * Modifying the MIKE+ database in a way that is consistent with the GUI. * Run different kinds of simulations (e.g. MIKE 1D, EPANET, SWMM) * Access certain GUI tools pythonically (e.g. import/export tool). > [!CAUTION] -> MIKE+ PY is experimental and under development. +> MIKE+Py is experimental and under development. > * Be aware that there may be bugs or unexpected behavior - use with caution. > * Always make copies of your MIKE+ databases and verify the outcome of scripts. > * If you encounter any issues or have any feedback, please report them on [GitHub Issues](https://github.com/DHI/mikeplus-python/issues). @@ -18,10 +18,10 @@ MIKE+ PY is a python interface for MIKE+. Its main features include: ## Installation -The version of MIKE+ PY you install must match the version of MIKE+ installed on your desktop. +The version of MIKE+Py you install must match the version of MIKE+ installed on your desktop. > [!NOTE] -> MIKE+ PY is not yet available on PyPI since it is in the initial development stages. +> MIKE+Py is not yet available on PyPI since it is in the initial development stages. | MIKE+ Version | Install command| |:--------------|:---------------|