diff --git a/docs_input/build.rst b/docs_input/build.rst index 88bfa18a..684a2dcd 100644 --- a/docs_input/build.rst +++ b/docs_input/build.rst @@ -27,22 +27,21 @@ untested. Other requirements for optional components are listed below. Required Third-party Dependencies --------------------------------- -- CPM_ (this is included in the project source, so does not require a separate download) +- `CPM `_ (* Included in the project source and does not require a separate download) - `fmt `_ (CPM dependency) - `nloghmann::json `_ (CPM dependency) -- `rapids-cmake `_ -- `libcudacxx `_ - -.. _CPM: https://github.com/cpm-cmake/CPM.cmake +- `rapids-cmake `_ (* Included in the project source and does not require a separate download) +- `CCCL `_ 2.2.0+ Optional Third-party Dependencies --------------------------------- -- `GoogleTest `_ -- `pybind11 `_ -- `nvbench `_ -- `cutensor `_ -- `cutensornet `_ +- `CMake `_ 3.23.1+ (Required for running unit tests, benchmarks, or examples) +- `GoogleTest `_ 1.11.0+ (Required to run unit tests) +- `pybind11 `_ 2.6.2+ (Required for file I/O and some unit tests) +- `nvbench `_ Commit 1a13a2e (Required to run benchmarks) +- `cutensor `_ 1.7.0.1+ (Required when using `einsum`) +- `cutensornet `_ 23.03.0.20+ (Required when using `einsum`) Build Options ============= @@ -72,12 +71,7 @@ Building documentation will be covered later in this document. Unit tests ---------- MatX unit tests are compiled using **Google Test** as the test framework, and **pybind11** for verification. pybind11 provides an interface -to compare common Numpy and Scipy results with MatX without reimplementing complex functionality in C++. Required versions for these -libraries are: - -**Google test**: 1.11+ - -**pybind11**: 2.6.2 +to compare common Numpy and Scipy results with MatX without reimplementing complex functionality in C++. Both Google Test and pybind11 will be automatically downloaded by CPM when unit tests are enabled. If an offline copy of them exists, ``CPM_USE_LOCAL_PACKAGES`` can be used to override the download.