Name	Name	Last commit message	Last commit date
parent directory ..
cuopt	cuopt
cuopt_self_hosted	cuopt_self_hosted
cuopt_server	cuopt_server
libcuopt	libcuopt
.coveragerc	.coveragerc
README.md	README.md

Name

Last commit message

Last commit date

Python Modules

This directory contains the Python modules for the cuOpt project.

Package Structure

Each subdirectory contains the Python modules for a specific cuOpt package. For example, libcuopt directory contains the Python wrappers for the cuOpt C++ library. This is the main package for the cuOpt project. And it just loads shared libraries and make it available for other Python modules. cuopt Python package uses libcuopt package as dependency and build on top of it.

python/
├── libcuopt/
├── cuopt/
└── ...

Each of these Python modules have a tests directory that contains the tests for the module. Python tests are written using pytest. For example, python/cuopt/cuopt/tests/ directory contains the tests for the cuopt Python package.

python/
├── cuopt/
│   ├── cuopt/
│   │   └── tests/
│   └── ...
└── ...

Each of these Python modules have a pyproject.toml file that contains the dependencies for the module. For example, python/cuopt/pyproject.toml file contains the dependencies for the cuopt Python package.

python/
├── cuopt/
│   ├── pyproject.toml
│   └── ...
└── ...

The dependencies are defined in the dependencies.yaml file in the root folder. For example, the python/cuopt/pyproject.toml file contains the dependencies for the cuopt Python package. Therefore, any changes to dependencies should be done in the dependencies.yaml file. Please refer to different sections in the dependencies.yaml file for more details.