---
name: mikeplus
description: >
  A python script package to manipulate MIKE+ database, run simulation by using MIKE+ data, run tools based on MIKE+ data. Use when writing Python code that uses the mikeplus package.
license: Apache-2.0
compatibility: Requires Python >=3.12.
---

# MIKE+Py

A python script package to manipulate MIKE+ database, run simulation by using MIKE+ data, run tools based on MIKE+ data

## Installation

```bash
pip install mikeplus
```

## API overview

### Main

- `open`
- `create`
- `to_sql`

### Database

- `Database`
- `DatabaseError`
- `tables.TableCollection`

### Queries

Returned by the `select`, `insert`, `update` and `delete` methods of a table.

- `queries.BaseQuery`
- `queries.SelectQuery`
- `queries.InsertQuery`
- `queries.UpdateQuery`
- `queries.DeleteQuery`

### Scenarios

Returned by `Database.scenarios` and `Database.alternative_groups`.

- `scenarios.ScenarioCollection`
- `scenarios.Scenario`
- `scenarios.AlternativeGroupCollection`
- `scenarios.AlternativeGroup`
- `scenarios.Alternative`

### Table base classes

Shared by every table in `Database.tables`.

- `tables.BaseTable`
- `tables.BaseGeometryTable`
- `tables.BaseNodeTable`
- `tables.BaseColumns`
- `tables.BaseTableCollection`

### Tools

- `tools.ImportTool`
- `tools.InterpolationTool`
- `tools.TopoRepairTool`
- `tools.ConnectionRepairTool`
- `tools.CreateValvesFromPointsTool`
- `tools.DemandConnectionTool`
- `tools.DemandAggregationTool`
- `tools.CathSlopeLengthProcess`

### Utilities

- `utilities.get_nearest_river_at`
- `utilities.get_nearest_river_chainage_at`

## Resources

- [Full documentation](https://dhi.github.io/mikepluspy/)
- [llms.txt](llms.txt) — Indexed API reference for LLMs
- [llms-full.txt](llms-full.txt) — Comprehensive documentation for LLMs