From 72e10626fccec7ea48eefad84fc54e553c66c075 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Sun, 6 Apr 2025 05:14:52 +0100 Subject: [PATCH] Update README.md to enhance installation instructions for the Python package --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e13f367..15edd62 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,20 @@ A Rust implementation of the [Macrosynergy Python Package](https://github.com/ma ## Build and install the Python package +Create a virtual environment: ```bash python -m venv .venv +``` + +```bash # source .venv/bin/activate ./.venv/Scripts/activate -pip install maturin -maturin develop --release +pip install uv +uv pip install maturin jupyter notebook +uv pip install . + +# alternatively, directly use maturin: +# maturin develop --release ``` ## Status