Skip to content

Commit

Permalink
docs: Add legacy CPU install instructions in user guide (#13676)
Browse files Browse the repository at this point in the history
  • Loading branch information
mcrumiller authored Apr 13, 2024
1 parent 5ab78ce commit 1d8870a
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/user-guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ Polars is a library and installation is as simple as invoking the package manage

``` bash
pip install polars

# Or for legacy CPUs without AVX2 support
pip install polars-ltc-cpu
```

=== ":fontawesome-brands-rust: Rust"
Expand All @@ -18,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
Expand Down

0 comments on commit 1d8870a

Please sign in to comment.