Skip to content

Commit cd991c5

Browse files
committed
Add tip to use uv
1 parent e8b6d07 commit cd991c5

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/user-guide/getting-started.qmd

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,26 @@
88

99
## Installation
1010

11+
::: {.callout-tip}
12+
# Using uv
13+
[uv](https://docs.astral.sh/uv/) is an extremely fast Python package and project manager that is 10-100x faster than pip, and also makes it easy to install Python and manage projects. With uv, creating a virtual environment is as easy as uv venv.
14+
:::
15+
16+
To install MIKE IO, run this command in a terminal:
17+
18+
::: {.panel-tabset}
19+
## pip
1120
```bash
1221
pip install mikeio
1322
```
1423

24+
## uv
25+
```bash
26+
uv pip install mikeio
27+
```
28+
29+
:::
30+
1531
## {{< fa database >}} Dataset
1632
The [Dataset](dataset.qmd) is the common MIKE IO data structure for data read from dfs files.
1733
The [](`mikeio.read`) method returns a Dataset with a [DataArray](dataarray.qmd) for each item.

0 commit comments

Comments
 (0)