Skip to content

Commit

Permalink
fix: update setup instructions (rye -> uv) (#1176)
Browse files Browse the repository at this point in the history
  • Loading branch information
lwwmanning authored Nov 1, 2024
1 parent f83a093 commit 968450f
Showing 1 changed file with 22 additions and 7 deletions.
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ Vortex to model more complex arrays while still exposing a logical interface. Fo
`ChunkedArray` where the first chunk is run-length encoded and the second chunk is dictionary encoded.
In Arrow, `RunLengthArray` and `DictionaryArray` are separate incompatible types, and so cannot be combined in this way.

### Usage
## Usage

For best performance we recommend using [MiMalloc](https://github.com/microsoft/mimalloc) as the application's
allocator.
Expand All @@ -199,19 +199,34 @@ Please see [CONTRIBUTING.md](CONTRIBUTING.md).

## Setup

In order to build vortex, you may also need to install the flatbuffer compiler (flatc):

### Mac

The project has several optional-but-recommended external dependencies:

```bash
# Required if you want to modify any of the .fbs or .proto files
brew install flatbuffers protobuf

# Required for benchmarks
brew install duckdb
```

You also need the Rust toolchain installed. If you haven't already, install [rustup](https://rustup.rs/)
with one of the following commands:

```bash
brew install flatbuffers
# option 1
brew install rustup

# option 2
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

This repo uses rye to manage the combined Rust/Python monorepo build. First, make sure to run:
This repo uses uv to manage the combined Rust/Python monorepo build. After installing uv, make sure to run:

```bash
# Install Rye from https://rye-up.com, and setup the virtualenv
rye sync
# Install uv from https://docs.astral.sh/uv/getting-started/installation/
uv sync
```

## License
Expand Down

0 comments on commit 968450f

Please sign in to comment.