Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Doc build error #80

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
python-version: "3.12"

- name: Install mikeplus
run: pip install .[dev]
run: pip install .[dev,doc]

- name: MkDocs
run: mkdocs build
Expand Down
23 changes: 14 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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","mkdocs-material","mkdocstrings","mkdocstrings-python"]

[project.urls]
"Homepage" = "https://github.com/DHI/mikepluspy"
Expand Down
Loading