Skip to content

Commit

Permalink
Add uv installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
giswqs committed Jan 26, 2025
1 parent c1604cb commit 9954731
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# Installation

## Install using uv

[uv](https://docs.astral.sh/uv/) is an extremely fast Python package and project manager, written in Rust. Follow the [instructions](https://docs.astral.sh/uv/getting-started/installation/) on the uv website to install uv on your computer. Once uv is installed, you can install **hypercoast** using the following command:

```bash
uv venv
uv pip install hypercoast jupyterlab
```

To run JupyterLab, use the following command:

```bash
uv run jupyter lab
```


## Install from PyPI

**hypercoast** is available on [PyPI](https://pypi.org/project/hypercoast/). To install **hypercoast**, run this command in your terminal:
Expand Down

0 comments on commit 9954731

Please sign in to comment.