https://github.com/yangeorget/nucs

NuCS is a Python constraint programming library for solving Constraint Satisfaction and Optimization Problems over finite domains
https://github.com/yangeorget/nucs

branch-and-bound constraint-optimisation-problem constraint-programming constraint-satisfaction-problem constraint-solver constraints csp numba numpy operational-research optimization python python-3 python-library solver

Last synced: 4 days ago
JSON representation

NuCS is a Python constraint programming library for solving Constraint Satisfaction and Optimization Problems over finite domains

• Host: GitHub
• URL: https://github.com/yangeorget/nucs
• Owner: yangeorget
• License: mit
• Created: 2024-04-22T20:13:32.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2026-03-28T19:10:16.000Z (11 days ago)
• Last Synced: 2026-03-28T20:36:00.274Z (11 days ago)
• Topics: branch-and-bound, constraint-optimisation-problem, constraint-programming, constraint-satisfaction-problem, constraint-solver, constraints, csp, numba, numpy, operational-research, optimization, python, python-3, python-library, solver
• Language: Python
• Homepage: https://pypi.org/project/NuCS/
• Size: 2.61 MB
• Stars: 54
• Watchers: 1
• Forks: 1
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
![NucS logo](https://raw.githubusercontent.com/yangeorget/nucs/main/assets/nucs.png)

![pypi version](https://img.shields.io/pypi/v/nucs?color=blue&label=pypi%20version&logo=pypi&logoColor=white)

![pypi downloads](https://img.shields.io/pypi/dm/NUCS)

![python version](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fyangeorget%2Fnucs%2Fmain%2Fpyproject.toml)

![numba version](https://img.shields.io/badge/numba-v0.65-blue)

![numpy version](https://img.shields.io/badge/numpy-v2.4.2-blue)

![tests](https://github.com/yangeorget/nucs/actions/workflows/test.yml/badge.svg)

![coverage](https://img.shields.io/badge/coverage-85-brightgreen)

![doc](https://img.shields.io/readthedocs/nucs)

![license](https://img.shields.io/github/license/yangeorget/nucs)

## TLDR

NuCS is a Python library for solving Constraint Satisfaction and Optimization Problems.

Because it is 100% written in Python,

NuCS is easy to install and allows to model complex problems in a few lines of code.

The NuCS solver is also very fast because it is powered by [Numpy](https://numpy.org/)

and [Numba](https://numba.pydata.org/).

## Installation

```bash

pip install nucs

```

## Documentation

Check out [NuCS documentation](https://nucs.readthedocs.io/).

## With NuCS, in a few seconds you can ...

### Find all 14200 solutions to the [12-queens problem](https://www.csplib.org/Problems/prob054/)

```bash

NUMBA_CACHE_DIR=.numba/cache python -m nucs.examples.queens -n 12

```

![queens](https://raw.githubusercontent.com/yangeorget/nucs/main/assets/queens.gif)

### Compute the 92 solutions to the [BIBD(8,14,7,4,3) problem](https://www.csplib.org/Problems/prob028/)

```bash

NUMBA_CACHE_DIR=.numba/cache python -m nucs.examples.bibd -v 8 -b 14 -r 7 -k 4 -l 3

```

![bibd](https://raw.githubusercontent.com/yangeorget/nucs/main/assets/bibd.gif)

### Demonstrate that the optimal [10-marks Golomb ruler](https://www.csplib.org/Problems/prob006/) length is 55

```bash

NUMBA_CACHE_DIR=.numba/cache python -m nucs.examples.golomb -n 10

```

![golomb](https://raw.githubusercontent.com/yangeorget/nucs/main/assets/golomb.gif)