From 647584b6374ba87f5b49b52364a17a5995cc370c Mon Sep 17 00:00:00 2001 From: Marshall Crumiller Date: Fri, 12 Jan 2024 10:18:12 -0500 Subject: [PATCH] Add Big Index/Legacy installation sections --- docs/user-guide/installation.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/user-guide/installation.md b/docs/user-guide/installation.md index 20eeba96caca..c362751ac782 100644 --- a/docs/user-guide/installation.md +++ b/docs/user-guide/installation.md @@ -21,6 +21,36 @@ Polars is a library and installation is as simple as invoking the package manage polars = { version = "x", features = ["lazy", ...]} ``` +### Big Index + +By default, polars is limited to 2^32 (~4.2 billion rows). To increase this limit 2^64 (~18 quintillion) by enabling big index: + +=== ":fontawesome-brands-python: Python" + + ``` bash + pip install polars-u64-idx + ``` + +=== ":fontawesome-brands-rust: Rust" + + ``` shell + cargo add polars -F bigidx + + # Or Cargo.toml + [dependencies] + polars = { version = "x", features = ["bigidx", ...] } + ``` + +### Legacy CPU + +To install polars on an old CPU without [AVX](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions) support: + +=== ":fontawesome-brands-python: Python" + + ``` bash + pip install polars-lts-cpu + ``` + ## Importing To use the library import it into your project