Skip to content

install.md

Latest commit

 

History

History
61 lines (45 loc) · 1.43 KB

install.md

File metadata and controls

61 lines (45 loc) · 1.43 KB
Raw

Install

vx CLI

The vx command-line tool lets you convert, inspect, browse, and query Vortex files from the terminal.

::::{tab-set}

:::{tab-item} Binstall (recommended)

cargo binstall vortex-tui

Downloads a pre-built binary. Requires cargo-binstall. :::

:::{tab-item} pip

pip install vortex-data

This also installs the Python library. See the Python quickstart for library usage. :::

:::{tab-item} uvx

uvx --from vortex-data vx --help

Runs the CLI without installing. Requires uv. :::

:::{tab-item} Cargo

cargo install vortex-tui

Builds from source. This can be slow due to the large dependency tree. :::

::::

Verify the installation:

vx --help

Using Vortex as a library

The vx CLI is the quickest way to get started, but Vortex can also be used as a library for reading, writing, and manipulating compressed arrays programmatically. See the language quickstarts for Python, Rust, and Java.

Sample data

This quickstart uses the NYC Yellow Taxi trip dataset. More months and datasets are available from the NYC TLC trip record data page.

Download a single month (~50 MB Parquet):

curl -O https://d37ci6vzurychx.cloudfront.net/trip-data/yellow_tripdata_2024-01.parquet