magnus167/msyrs
1
0
Fork 0
mirror of https://github.com/Magnus167/msyrs.git synced 2025-08-20 13:00:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md to enhance installation instructions for the Python package

Browse Source
This commit is contained in:
Palash Tyagi 2025-04-06 05:14:52 +01:00
parent 977a94086f
commit 72e10626fc
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -4,12 +4,20 @@ A Rust implementation of the [Macrosynergy Python Package](https://github.com/ma
## Build and install the Python package ## Build and install the Python package
Create a virtual environment:
```bash ```bash
python -m venv .venv python -m venv .venv
```
```bash
# source .venv/bin/activate # source .venv/bin/activate
./.venv/Scripts/activate ./.venv/Scripts/activate
pip install maturin pip install uv
maturin develop --release uv pip install maturin jupyter notebook
uv pip install .
# alternatively, directly use maturin:
# maturin develop --release
``` ```
## Status ## Status