Merge pull request #12 from DHI/2024-experimental-release

Update readme for 2024 experimental release.

CHANGELOG.md

@@ -1,11 +1,11 @@
-# mikeplus script Changelog
+# MIKE+Py Changelog
 
 ## [Unreleased]
 
-## [0.1] - 2023-08-30
+## [2024.0.0] - 2024-01-30
 
 ### 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

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
+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) 

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