Skip to content

Update Source build instructions#62

Merged
rgsl888prabhu merged 4 commits intoNVIDIA:branch-25.05from
rgsl888prabhu:update_source_build
Jun 9, 2025
Merged

Update Source build instructions#62
rgsl888prabhu merged 4 commits intoNVIDIA:branch-25.05from
rgsl888prabhu:update_source_build

Conversation

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator

This simplifies and update source build instructions.

@rgsl888prabhu rgsl888prabhu self-assigned this Jun 2, 2025
@rgsl888prabhu rgsl888prabhu added doc Improvements or additions to documentation non-breaking Introduces a non-breaking change labels Jun 2, 2025
@chris-maes
Copy link
Copy Markdown
Contributor

We say the following


**Note:** Using a conda environment is the easiest way to satisfy the library's dependencies.

- 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)

I think it might be good to

  1. Make a bit stronger statement that "is the easiest way to satisfy the library's dependencies". It sound like conda is really the only way to satisfy these dependencies. So maybe we should say
Building from source without conda is very difficult. We highly recommend that users build cuOpt inside a conda environment
  1. Include instructions for installing miniconda. I worry a bit about pointing users to miniconda installation instructions. Maybe we could add one or two lines that show how to install miniconda?

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator Author

We say the following


**Note:** Using a conda environment is the easiest way to satisfy the library's dependencies.

- 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)

I think it might be good to

  1. Make a bit stronger statement that "is the easiest way to satisfy the library's dependencies". It sound like conda is really the only way to satisfy these dependencies. So maybe we should say
Building from source without conda is very difficult. We highly recommend that users build cuOpt inside a conda environment
  1. Include instructions for installing miniconda. I worry a bit about pointing users to miniconda installation instructions. Maybe we could add one or two lines that show how to install miniconda?

Providing instruction on miniconda would add additional burden on us to make sure it is in working condition, it would be better if they can just go through miniconda website to install. And they might also have many options. and we might not want to limit them to number of options.

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator Author

We say the following


**Note:** Using a conda environment is the easiest way to satisfy the library's dependencies.

- 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)

I think it might be good to

  1. Make a bit stronger statement that "is the easiest way to satisfy the library's dependencies". It sound like conda is really the only way to satisfy these dependencies. So maybe we should say
Building from source without conda is very difficult. We highly recommend that users build cuOpt inside a conda environment
  1. Include instructions for installing miniconda. I worry a bit about pointing users to miniconda installation instructions. Maybe we could add one or two lines that show how to install miniconda?

Providing instruction on miniconda would add additional burden on us to make sure it is in working condition, it would be better if they can just go through miniconda website to install. And they might also have many options. and we might not want to limit them to number of options.

But let me update the link that will take them directly to linux installation page

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator Author

@chris-maes @rg20 May I get your review ?

@rgsl888prabhu rgsl888prabhu merged commit ccbee4f into NVIDIA:branch-25.05 Jun 9, 2025
56 checks passed
jieyibi pushed a commit to yining043/cuopt that referenced this pull request Mar 26, 2026
<!--

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation non-breaking Introduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants