Skip to content

Update Source build instructions #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rgsl888prabhu merged 4 commits into from
Jun 9, 2025
Merged

Update Source build instructions #62

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
64d3be0
Update Source build instruction
rgsl888prabhu Jun 2, 2025
95e43c6
Add miniforge and address reviews
rgsl888prabhu Jun 2, 2025
05807d2
Merge branch 'branch-25.05' into update_source_build
rgsl888prabhu Jun 2, 2025
9f5ebda
Merge branch 'branch-25.05' into update_source_build
rgsl888prabhu Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 5 additions & 12 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,19 +64,10 @@ source and contribute to its development. Other operating systems may be compati
currently tested.

Building NVIDIA cuOpt with the provided conda environment is recommended for users who wish to enable all
library features. The following instructions are for building with a conda environment. Dependencies
for a minimal build of NVIDIA cuOpt without using conda are also listed below.
library features. The following instructions are for building with a conda environment.

### General requirements

Compilers:

These will be installed while creating the Conda environment

* `gcc` version 13.0+
* `nvcc` version 12.8+
* `cmake` version 3.30.4+

CUDA/GPU Runtime:

* CUDA 12.8
Expand Down Expand Up @@ -107,11 +98,13 @@ cd $CUOPT_HOME

#### Building with a conda environment

**Note:** Using a conda environment is the easiest way to satisfy the library's dependencies.
**Note:** Building from source without conda is very difficult. We highly recommend that users build cuOpt inside a conda environment

- Create the conda development environment:

Please install conda if you don't have it already. You can install it from [https://docs.conda.io/en/latest/miniconda.html](https://docs.conda.io/en/latest/miniconda.html)
Please install conda if you don't have it already. You can install [miniforge](https://conda-forge.org/download/) or [miniconda](https://www.anaconda.com/docs/getting-started/miniconda/install#linux)

**Note:** We recommend using [mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html) as the package manager for the conda environment. Mamba is faster and more efficient than conda. And it's the default package manager for miniforge. If you are using mamba just replace `conda` with `mamba` in the following commands.

```bash
# create the conda environment (assuming in base `cuopt` directory)
Expand Down