From 0ee2c6ec7100f3409e3ec894207be55990b97103 Mon Sep 17 00:00:00 2001 From: wuwwen Date: Fri, 29 Nov 2024 11:09:33 +0800 Subject: [PATCH 1/7] Solve documentation build error. --- .github/workflows/docs.yml | 2 +- docs/index.md | 23 ++++++++++++++--------- 2 files changed, 15 insertions(+), 10 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index f4f46ad..3ace7be 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -20,7 +20,7 @@ jobs: python-version: "3.12" - name: Install mikeplus - run: pip install .[dev] + run: pip install .[doc] - name: MkDocs run: mkdocs build diff --git a/docs/index.md b/docs/index.md index cea47ab..0af7c01 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,10 @@ ![logo](https://raw.githubusercontent.com/DHI/mikepluspy/main/images/logo/mikeplus-py.svg) # MIKE+Py: automate your workflows. + ![Python version](https://img.shields.io/pypi/pyversions/mikeplus.svg) + [![Full test](https://github.com/DHI/mikepluspy/actions/workflows/full_test.yml/badge.svg)](https://github.com/DHI/mikepluspy/actions/workflows/full_test.yml) +[![PyPI version](https://badge.fury.io/py/mikeplus.svg)](https://badge.fury.io/py/mikeplus) +![OS](https://img.shields.io/badge/OS-Windows-blue) +![Downloads](https://img.shields.io/pypi/dm/mikeplus) 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. @@ -14,27 +19,27 @@ MIKE+Py is a python interface for MIKE+. Its main features include: ## Requirements * MIKE+ 2024 (or greater) with valid license -* Python x64 3.8 to 3.12 -* Windows operating system +* Python x64 3.9 to 3.12 +* Windows ## Installation 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/mikepluspy/archive/refs/tags/v2024.0-latest.zip` | +| MIKE+ 2025 | `pip install mikeplus` | +| MIKE+ 2024 Update 1 | `pip install mikeplus==2024.1.*` | +| MIKE+ 2024 | `pip install mikeplus==2024.0.*` | ## Examples -Please check out the jupyter notebooks here: https://github.com/DHI/mikepluspy/tree/main/notebooks +Please check out our [collection of jupyter notebooks] (https://github.com/DHI/mikepluspy/tree/main/notebooks) to get started with MIKE+Py. ## Where can I get help? -* General help, new ideas and feature requests - [GitHub Discussions](http://github.com/DHI/mikepluspy/discussions) -* Bugs - [GitHub Issues](https://github.com/DHI/mikepluspy/issues) +* Bugs - [GitHub Issues](https://github.com/DHI/mikepluspy/issues) +* Feature requests - [GitHub Issues](https://github.com/DHI/mikepluspy/issues) +* Other - [GitHub Discussions](http://github.com/DHI/mikepluspy/discussions) ## Getting started From 965358c4648f0c17cb8826b4d69acbe16d9ee445 Mon Sep 17 00:00:00 2001 From: wuwwen Date: Fri, 29 Nov 2024 11:27:15 +0800 Subject: [PATCH 2/7] Fix the doc build --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index f68c2c5..84bedef 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -37,7 +37,7 @@ classifiers = [ [project.optional-dependencies] dev = ["pytest", "ruff", "shapely"] test = ["pytest", "shapely"] -doc = ["sphinx", "myst-parser","sphinx-book-theme","mkdocs==1.5.3","mkdocs-material==9.4.14","mkdocstrings==0.24.0","mkdocstrings-python==1.7.5"] +doc = ["sphinx", "myst-parser","sphinx-book-theme","mkdocs==1.5.3","mkdocs-material==9.4.14","mkdocstrings==0.24.0","mkdocstrings-python==1.7.5", "mkdocstrings-python-legacy"] [project.urls] "Homepage" = "https://github.com/DHI/mikepluspy" From 9b46fd37af15adaf20e7c062396fca23dfe88114 Mon Sep 17 00:00:00 2001 From: wuwwen Date: Fri, 29 Nov 2024 11:36:55 +0800 Subject: [PATCH 3/7] Try to fix doc build --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 84bedef..9dad236 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -37,7 +37,7 @@ classifiers = [ [project.optional-dependencies] dev = ["pytest", "ruff", "shapely"] test = ["pytest", "shapely"] -doc = ["sphinx", "myst-parser","sphinx-book-theme","mkdocs==1.5.3","mkdocs-material==9.4.14","mkdocstrings==0.24.0","mkdocstrings-python==1.7.5", "mkdocstrings-python-legacy"] +doc = ["sphinx", "myst-parser","sphinx-book-theme","mkdocs==1.5.3","mkdocs-material==9.4.14","mkdocstrings==0.24.0","mkdocstrings-python==1.7.5", "mkdocstrings[python]", "mkdocstrings-python-legacy"] [project.urls] "Homepage" = "https://github.com/DHI/mikepluspy" From c19c753757cd169a06aee1a22de30d3d1dbfbb8e Mon Sep 17 00:00:00 2001 From: wuwwen Date: Fri, 29 Nov 2024 11:47:41 +0800 Subject: [PATCH 4/7] Update for doc build --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 9dad236..52dfca6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -37,7 +37,7 @@ classifiers = [ [project.optional-dependencies] dev = ["pytest", "ruff", "shapely"] test = ["pytest", "shapely"] -doc = ["sphinx", "myst-parser","sphinx-book-theme","mkdocs==1.5.3","mkdocs-material==9.4.14","mkdocstrings==0.24.0","mkdocstrings-python==1.7.5", "mkdocstrings[python]", "mkdocstrings-python-legacy"] +doc = ["sphinx", "myst-parser","sphinx-book-theme","mkdocs==1.5.3","mkdocs-material==9.4.14","mkdocstrings==0.24.0","mkdocstrings-python==1.7.5", "pytkdocs[numpy-style]", "mkdocstrings-python-legacy"] [project.urls] "Homepage" = "https://github.com/DHI/mikepluspy" From a6e09b5c15fdedfa22cdedbe4542628ae9060e11 Mon Sep 17 00:00:00 2001 From: wuwwen Date: Fri, 29 Nov 2024 13:05:45 +0800 Subject: [PATCH 5/7] test doc build --- .github/workflows/docs.yml | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 3ace7be..46b8987 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -20,7 +20,7 @@ jobs: python-version: "3.12" - name: Install mikeplus - run: pip install .[doc] + run: pip install .[dev,docs] - name: MkDocs run: mkdocs build diff --git a/pyproject.toml b/pyproject.toml index 52dfca6..79620a0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -37,7 +37,7 @@ classifiers = [ [project.optional-dependencies] dev = ["pytest", "ruff", "shapely"] test = ["pytest", "shapely"] -doc = ["sphinx", "myst-parser","sphinx-book-theme","mkdocs==1.5.3","mkdocs-material==9.4.14","mkdocstrings==0.24.0","mkdocstrings-python==1.7.5", "pytkdocs[numpy-style]", "mkdocstrings-python-legacy"] +doc = ["sphinx", "myst-parser","sphinx-book-theme","mkdocs","mkdocs-material","mkdocstrings","mkdocstrings-python","mkdocstrings[python]","mkdocstrings-python-legacy","pytkdocs[numpy-style]"] [project.urls] "Homepage" = "https://github.com/DHI/mikepluspy" From a6881537ea4e5649400426deae129e275f4b7f18 Mon Sep 17 00:00:00 2001 From: wuwwen Date: Fri, 29 Nov 2024 13:08:56 +0800 Subject: [PATCH 6/7] test doc build --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 46b8987..e37871c 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -20,7 +20,7 @@ jobs: python-version: "3.12" - name: Install mikeplus - run: pip install .[dev,docs] + run: pip install .[dev,doc] - name: MkDocs run: mkdocs build From e3aa2ea4bbaec6b5f3fe811fa31c7536caa41ca9 Mon Sep 17 00:00:00 2001 From: wuwwen Date: Fri, 29 Nov 2024 13:24:19 +0800 Subject: [PATCH 7/7] test doc --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 79620a0..733e46d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -37,7 +37,7 @@ classifiers = [ [project.optional-dependencies] dev = ["pytest", "ruff", "shapely"] test = ["pytest", "shapely"] -doc = ["sphinx", "myst-parser","sphinx-book-theme","mkdocs","mkdocs-material","mkdocstrings","mkdocstrings-python","mkdocstrings[python]","mkdocstrings-python-legacy","pytkdocs[numpy-style]"] +doc = ["sphinx", "myst-parser","sphinx-book-theme","mkdocs","mkdocs-material","mkdocstrings","mkdocstrings-python"] [project.urls] "Homepage" = "https://github.com/DHI/mikepluspy"