Skip to content

Commit ecc8748

Browse files
authored
[docs] Update Building from Source section (#270)
Signed-off-by: Ben Howe <[email protected]>
1 parent 7f6cda0 commit ecc8748

File tree

1 file changed

+2
-87
lines changed

1 file changed

+2
-87
lines changed

docs/sphinx/quickstart/installation.rst

Lines changed: 2 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -63,93 +63,8 @@ The container includes:
6363
Building from Source
6464
^^^^^^^^^^^^^^^^^^^^
6565

66-
Prerequisites
67-
~~~~~~~~~~~~~
68-
69-
Before building CUDA-QX from source, ensure your system meets the following requirements:
70-
71-
* **CUDA-Q**: The NVIDIA quantum-classical programming model
72-
* **CMake**: Version 3.28 or higher (``pip install "cmake<4"``), less than 4.0
73-
* **GCC**: Version 11 or higher
74-
* **Python**: Version 3.10, 3.11, 3.12, or 3.13
75-
* **NVIDIA GPU**: CUDA-capable GPU with compute capability 7.0 or higher
76-
* **Git**: For cloning the repository
77-
78-
Build Instructions
79-
~~~~~~~~~~~~~~~~~~~
80-
81-
1. Clone the repository:
82-
83-
.. code-block:: bash
84-
85-
git clone https://github.com/nvidia/cudaqx
86-
cd cudaqx
87-
88-
2. Create and enter build directory:
89-
90-
.. code-block:: bash
91-
92-
mkdir build && cd build
93-
94-
3. Configure with CMake:
95-
96-
.. code-block:: bash
97-
98-
cmake .. -G Ninja \
99-
-DCUDAQX_ENABLE_LIBS="all" \
100-
-DCUDAQX_INCLUDE_TESTS=ON \
101-
-DCUDAQX_BINDINGS_PYTHON=ON \
102-
-DCUDAQ_DIR=$HOME/.cudaq/lib/cmake/cudaq \
103-
-DCMAKE_CXX_FLAGS="-Wno-attributes" \
104-
-DCMAKE_BUILD_TYPE=Release \
105-
-DCMAKE_INSTALL_PREFIX=$HOME/.cudaqx
106-
107-
4. Build and install:
108-
109-
.. code-block:: bash
110-
111-
ninja install
112-
113-
CMake Build Options
114-
~~~~~~~~~~~~~~~~~~~~
115-
116-
* ``CUDAQX_ENABLE_LIBS``: Specify which libraries to build (``all``, ``qec``, ``solvers``)
117-
* ``CUDAQX_INCLUDE_TESTS``: Enable building of tests
118-
* ``CUDAQX_BINDINGS_PYTHON``: Enable Python bindings
119-
* ``CUDAQ_DIR``: Path to CUDA-Q installation
120-
* ``CMAKE_INSTALL_PREFIX``: Installation directory
121-
122-
Verifying Installation
123-
-----------------------
124-
125-
To verify your installation, run the following Python code:
126-
127-
.. code-block:: python
128-
129-
import cudaq_qec as qec
130-
import cudaq_solvers as solvers
131-
132-
133-
Troubleshooting (Common Issues)
134-
--------------------------------
135-
136-
1. **CMake configuration fails**:
137-
* Ensure CUDA-Q is properly installed
138-
* Verify CMake version (``cmake --version``)
139-
* Check GCC version (``gcc --version``)
140-
141-
2. **CUDA device not found**:
142-
* Verify NVIDIA driver installation
143-
* Check CUDA toolkit installation
144-
* Ensure GPU compute capability is supported
145-
146-
3. **Python bindings not found**:
147-
* Confirm ``CUDAQX_BINDINGS_PYTHON=ON`` during build
148-
* Check Python environment activation
149-
* Verify installation path is in ``PYTHONPATH``
150-
151-
For additional support, please visit our `GitHub Issues <https://github.com/nvidia/cudaqx/issues>`_ page.
152-
66+
The instructions for building CUDA-QX from source are maintained on our GitHub
67+
repository: `Building CUDA-QX from Source <https://github.com/NVIDIA/cudaqx/blob/main/Building.md>`__.
15368

15469
Known Blackwell Issues
15570
----------------------

0 commit comments

Comments
 (0)