From db2b351796f69297138da46b092c2e251462c995 Mon Sep 17 00:00:00 2001 From: Jonathan Wang <31040440+jonathanpwang@users.noreply.github.com> Date: Tue, 26 Aug 2025 15:38:06 -0700 Subject: [PATCH 1/2] docs(book): add installation instructions for tco --- .../pages/book/getting-started/install.mdx | 56 ++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-) diff --git a/docs/vocs/docs/pages/book/getting-started/install.mdx b/docs/vocs/docs/pages/book/getting-started/install.mdx index 94c8344f6c..1f3d462f80 100644 --- a/docs/vocs/docs/pages/book/getting-started/install.mdx +++ b/docs/vocs/docs/pages/book/getting-started/install.mdx @@ -97,7 +97,6 @@ It is possible to install the OpenVM CLI with support for Nvidia GPUs. This requ With this version of the CLI, the `prove app` and `prove stark` commands will utilize the Nvidia GPU for hardware acceleration. Currently only single GPU support is available through the CLI. - ### Option 1: Install Via Git URL (Recommended) Begin the installation: @@ -170,3 +169,58 @@ export LD_LIBRARY_PATH=/usr/local/cuda/lib64${LD_LIBRARY_PATH:+:${LD_LIBRARY_PAT Note that `/usr/local/cuda` is a symlink for the latest version of CUDA installed. You are now ready to [install](#install-with-nvidia-gpu-support) the OpenVM CLI. + +## Install with experimental nightly features + +For the best execution performance, the CLI may be installed with optimizations that utilize [experimental Rust features](https://github.com/rust-lang/rust/issues/112788). These optimizations may be enabled on top of the standard CPU installation as well as the Nvidia GPU installation. We provide installation instructions for both versions, assuming the prerequisites ([CPU](#installation-prerequisites), [GPU](#installation-prerequisites-cuda)) are already met. + +This installation requires a nightly Rust toolchain. To install the nightly toolchain, run: + +```bash +rustup install nightly-2025-08-19 +``` + +### Option 1: Install Via Git URL (Recommended) + +Begin the installation: + +:::code-group +```bash [Without GPU] +cargo +nightly-2025-08-19 install --locked --git https://github.com/openvm-org/openvm.git --tag v1.4.0-rc.8 --features tco cargo-openvm +``` +```bash [Nvidia GPU] +cargo +nightly-2025-08-19 install --locked --git https://github.com/openvm-org/openvm.git --tag v1.4.0-rc.8 --features tco,cuda cargo-openvm +``` +::: + +This will globally install `cargo-openvm`. You can validate a successful installation with: + +```bash +cargo openvm --version +``` + +### Option 2: Build from source + +To build from source, first clone the repository. + +```bash +git clone --branch v1.4.0-rc.8 --single-branch https://github.com/openvm-org/openvm.git +cd openvm +``` + +Then begin the installation: + +:::code-group +```bash [Without GPU] +cargo +nightly-2025-08-19 install --locked --force --path crates/cli --features tco +``` +```bash [Nvidia GPU] +cargo +nightly-2025-08-19 install --locked --force --path crates/cli --features tco,cuda +``` +::: + +This will globally install `cargo-openvm`. You can validate a successful installation with: + +```bash +cargo openvm --version +``` From 98ca755ba1daeab314650090f027a9aa5adc15d1 Mon Sep 17 00:00:00 2001 From: Jonathan Wang <31040440+jonathanpwang@users.noreply.github.com> Date: Wed, 27 Aug 2025 11:38:46 -0700 Subject: [PATCH 2/2] chore: rewordings --- docs/vocs/docs/pages/book/getting-started/install.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/vocs/docs/pages/book/getting-started/install.mdx b/docs/vocs/docs/pages/book/getting-started/install.mdx index 1f3d462f80..9ea7bfb2ac 100644 --- a/docs/vocs/docs/pages/book/getting-started/install.mdx +++ b/docs/vocs/docs/pages/book/getting-started/install.mdx @@ -91,7 +91,7 @@ svm use 0.8.19 ::: -## Installation with Nvidia GPU support +## Installation with Nvidia GPU Support It is possible to install the OpenVM CLI with support for Nvidia GPUs. This requires installation on a machine with an Nvidia GPU and associated drivers (see [Prerequisites (CUDA)](#installation-prerequisites-cuda)) @@ -170,7 +170,7 @@ Note that `/usr/local/cuda` is a symlink for the latest version of CUDA installe You are now ready to [install](#install-with-nvidia-gpu-support) the OpenVM CLI. -## Install with experimental nightly features +## Installation with Experimental Features For the best execution performance, the CLI may be installed with optimizations that utilize [experimental Rust features](https://github.com/rust-lang/rust/issues/112788). These optimizations may be enabled on top of the standard CPU installation as well as the Nvidia GPU installation. We provide installation instructions for both versions, assuming the prerequisites ([CPU](#installation-prerequisites), [GPU](#installation-prerequisites-cuda)) are already met. @@ -186,10 +186,10 @@ Begin the installation: :::code-group ```bash [Without GPU] -cargo +nightly-2025-08-19 install --locked --git https://github.com/openvm-org/openvm.git --tag v1.4.0-rc.8 --features tco cargo-openvm +cargo +nightly-2025-08-19 install --locked --git https://github.com/openvm-org/openvm.git --tag v1.4.0-rc.9 --features tco cargo-openvm ``` ```bash [Nvidia GPU] -cargo +nightly-2025-08-19 install --locked --git https://github.com/openvm-org/openvm.git --tag v1.4.0-rc.8 --features tco,cuda cargo-openvm +cargo +nightly-2025-08-19 install --locked --git https://github.com/openvm-org/openvm.git --tag v1.4.0-rc.9 --features tco,cuda cargo-openvm ``` ::: @@ -204,7 +204,7 @@ cargo openvm --version To build from source, first clone the repository. ```bash -git clone --branch v1.4.0-rc.8 --single-branch https://github.com/openvm-org/openvm.git +git clone --branch v1.4.0-rc.9 --single-branch https://github.com/openvm-org/openvm.git cd openvm ```