This is an automated email from the ASF dual-hosted git repository.
hcr pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/mahout.git
The following commit(s) were added to refs/heads/main by this push:
new fee2e013b [Docs] update qumat getting started! (#991)
fee2e013b is described below
commit fee2e013b0b235ed8274183539c24a3ec38432c1
Author: Ryan Huang <[email protected]>
AuthorDate: Sat Jan 31 00:46:25 2026 +0800
[Docs] update qumat getting started! (#991)
---
docs/getting-started-with-qumat.md | 36 ++++++++++++++++--------------------
1 file changed, 16 insertions(+), 20 deletions(-)
diff --git a/docs/getting-started-with-qumat.md
b/docs/getting-started-with-qumat.md
index 2c0e17298..000d1044a 100644
--- a/docs/getting-started-with-qumat.md
+++ b/docs/getting-started-with-qumat.md
@@ -4,35 +4,31 @@
Getting started with Qumat is easy, thanks to the simplified installation
process. You can install Qumat by choosing one of the following methods.
-### Method 1: Clone and Install Locally
+### Method 1: Install from PyPI (Recommended)
-```
-git clone https://github.com/apache/mahout
-cd mahout
-pip install .
+```bash
+pip install qumat
```
-### Method 2: Install via Git directly
+### Method 2: Install from Source (Development)
-```
-pip install git+https://github.com/apache/mahout
+For development or to get the latest changes, use
[uv](https://docs.astral.sh/uv/):
+
+```bash
+git clone https://github.com/apache/mahout
+cd mahout
+pip install uv
+uv sync # Core Qumat
+uv sync --extra qdp # With QDP (requires NVIDIA GPU + CUDA)
```
-Users might think these instructions are "too easy" due to the previous
complexity associated with installing Mahout. Rest assured, as part of the
Qumat reboot, we have made significant strides in simplifying both installation
and getting started.
+:::note Why uv?
+The project uses `uv` to handle dependency overrides required for Python 3.10+
compatibility with some backend dependencies.
+:::
## Dependencies
-Prior to installation, ensure Python 3.10+ is installed. Dependencies such as
Qiskit, Cirq, and Amazon Braket SDK will be managed by pip.
-
-## Installation from Source
-
-If you wish to build from source, use the following command:
-
-```
-git clone https://github.com/apache/mahout
-cd mahout
-pip install .
-```
+Prior to installation, ensure Python 3.10-3.12 is installed. Dependencies such
as Qiskit, Cirq, and Amazon Braket SDK will be managed automatically.
## Examples
