Skip to content

Commit ccbee4f

Browse files
Update Source build instructions (#62)
<!-- Thank you for contributing to cuOpt :) Here are some guidelines to help the review process go smoothly. 1. Please write a description in this text box of the changes that are being made. 2. Please ensure that you have written units tests for the changes made/features added. 3. If you are closing an issue please use one of the automatic closing words as noted here: https://help.github.com/articles/closing-issues-using-keywords/ 4. If your pull request is not ready for review but you want to make use of the continuous integration testing facilities please label it with `[WIP]`. 5. If your pull request is ready to be reviewed without requiring additional work on top of it, then remove the `[WIP]` label (if present) and replace it with `[REVIEW]`. If assistance is required to complete the functionality, for example when the C/C++ code of a feature is complete but Python bindings are still required, then add the label `[HELP-REQ]` so that others can triage and assist. The additional changes then can be implemented on top of the same PR. If the assistance is done by members of the rapidsAI team, then no additional actions are required by the creator of the original PR for this, otherwise the original author of the PR needs to give permission to the person(s) assisting to commit to their personal fork of the project. If that doesn't happen then a new PR based on the code of the original PR can be opened by the person assisting, which then will be the PR that will be merged. 6. Once all work has been done and review has taken place please do not add features or make changes out of the scope of those requested by the reviewer (doing this just add delays as already reviewed code ends up having to be re-reviewed/it is hard to tell what is new etc!). Further, please do not rebase your branch on main/force push/rewrite history, doing any of these causes the context of any comments made by reviewers to be lost. If conflicts occur against main they should be resolved by merging main into the branch used for making the pull request. Many thanks in advance for your cooperation! --> This simplifies and update source build instructions.
1 parent 5abbde3 commit ccbee4f

File tree

1 file changed

+5
-12
lines changed

1 file changed

+5
-12
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -64,19 +64,10 @@ source and contribute to its development. Other operating systems may be compati
6464
currently tested.
6565

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

7069
### General requirements
7170

72-
Compilers:
73-
74-
These will be installed while creating the Conda environment
75-
76-
* `gcc` version 13.0+
77-
* `nvcc` version 12.8+
78-
* `cmake` version 3.30.4+
79-
8071
CUDA/GPU Runtime:
8172

8273
* CUDA 12.8
@@ -107,11 +98,13 @@ cd $CUOPT_HOME
10798

10899
#### Building with a conda environment
109100

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

112103
- Create the conda development environment:
113104

114-
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)
105+
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)
106+
107+
**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.
115108

116109
```bash
117110
# create the conda environment (assuming in base `cuopt` directory)

0 commit comments

Comments
 (0)