doc: Installation instructions

biodatageeks · Dec 18, 2024 · bbb8664 · bbb8664
1 parent 0d440a4
commit bbb8664
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 1 deletion.
diff --git a/.github/workflows/publish_to_pypi.yml b/.github/workflows/publish_to_pypi.yml
@@ -10,6 +10,7 @@ on:
     paths-ignore:
       - 'docs/**'
       - 'benchmark/**'
+      - 'mkdocs.yml'
   pull_request:
   workflow_dispatch:
 

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/docs/performance.md b/docs/performance.md
@@ -0,0 +1 @@
+TBD
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -1,3 +1,18 @@
+[polars-bio](https://pypi.org/project/polars-bio/) is available on PyPI and can be installed with pip:
 ```shell
 pip install polars-bio
 ```
+There are binary versions for Linux (x86_64), MacOS (x86_64 and arm64) and Windows (x86_64).
+In case of other platforms, you can build polars-bio from source with [maturin](https://github.com/PyO3/maturin):
+```shell
+RUSTFLAGS="-Ctarget-cpu=native" maturin build --release  -m Cargo.toml
+```
+and you should see the following output:
+```shell
+Compiling polars_bio v0.2.11 (/Users/mwiewior/research/git/polars-bio)
+Finished `release` profile [optimized] target(s) in 1m 25s
+📦 Built wheel for abi3 Python ≥ 3.8 to /Users/mwiewior/research/git/polars-bio/target/wheels/polars_bio-0.2.11-cp38-abi3-macosx_11_0_arm64.whl
+
+```
+!!! note
+    Rust compiler and Cargo are required to build the package from source. [rustup](https://rustup.rs/) is the recommended way to install Rust.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,10 +8,12 @@ nav:
       - 🏃🏼‍♂️ Quick start: quickstart.md
       - 🔨Features: features.md
       - 📚 Tutorial: notebooks/tutorial.ipynb
+      - 🚀 Performance: performance.md
       - ⚙️ API reference: api.md
   - Quick start: quickstart.md
   - Features: features.md
   - Tutorial: notebooks/tutorial.ipynb
+  - Performance: performance.md
   - API reference: api.md
 
 plugins: