From ca772e3287763ebf95029be11a1272cfa65a1705 Mon Sep 17 00:00:00 2001 From: Qiusheng Wu Date: Sat, 25 Jan 2025 23:07:05 -0500 Subject: [PATCH] Add uv installation instructions (#150) --- docs/installation.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/installation.md b/docs/installation.md index 603afcf5..ed554929 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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: