NuCS 4.4.4__tar.gz

nucs-4.4.4/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+## Copyright (c) 2024 Yan Georget
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

nucs-4.4.4/NuCS.egg-info/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.1
+Name: NuCS
+Version: 4.4.4
+Summary: A Numpy and Numba based Python library for solving Constraint Satisfaction Problems over finite domains
+Author-email: Yan Georget <yan.georget@gmail.com>
+Project-URL: Homepage, https://github.com/yangeorget/nucs
+Project-URL: Issues, https://github.com/yangeorget/nucs/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: numba==0.60.0
+Requires-Dist: numpy<2.1
+Requires-Dist: rich
+
+![NucS logo](https://github.com/yangeorget/nucs/blob/main/assets/nucs.png?raw=true)
+
+
+![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)
+
+![numba version](https://img.shields.io/badge/numba-v0.60-blue)
+![numpy version](https://img.shields.io/badge/numpy-v2.0-blue)
+
+![tests](https://github.com/yangeorget/nucs/actions/workflows/test.yml/badge.svg)
+![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 --log_level=INFO
+```
+```bash
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.solver - Problem has 3 propagators
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.solver - Problem has 12 variables
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+2024-11-12 17:24:49,200 - INFO - nucs.solvers.multiprocessing_solver - MultiprocessingSolver has 1 processors
+{
+    'ALG_BC_NB': 262011,
+    'ALG_BC_WITH_SHAVING_NB': 0,
+    'ALG_SHAVING_NB': 0,
+    'ALG_SHAVING_CHANGE_NB': 0,
+    'ALG_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 0,
+    'PROPAGATOR_FILTER_NB': 2269980,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 990450,
+    'PROPAGATOR_INCONSISTENCY_NB': 116806,
+    'SOLVER_BACKTRACK_NB': 131005,
+    'SOLVER_CHOICE_NB': 131005,
+    'SOLVER_CHOICE_DEPTH': 10,
+    'SOLVER_SOLUTION_NB': 14200
+}
+```
+
+### 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 --symmetry_breaking --log_level=INFO
+```
+```bash
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.solver - Problem has 462 propagators
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.solver - Problem has 504 variables
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 1
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 0
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+{
+    'ALG_BC_NB': 1425,
+    'ALG_BC_WITH_SHAVING_NB': 0,
+    'ALG_SHAVING_NB': 0,
+    'ALG_SHAVING_CHANGE_NB': 0,
+    'ALG_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 4711,
+    'PROPAGATOR_FILTER_NB': 104392,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 73792,
+    'PROPAGATOR_INCONSISTENCY_NB': 621,
+    'SOLVER_BACKTRACK_NB': 712,
+    'SOLVER_CHOICE_NB': 712,
+    'SOLVER_CHOICE_DEPTH': 19,
+    'SOLVER_SOLUTION_NB': 92
+}
+```
+
+### 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 --symmetry_breaking --log_level=INFO
+```
+```bash
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.solver - Problem has 82 propagators
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.solver - Problem has 45 variables
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 0
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 2
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+2024-11-12 17:27:45,172 - INFO - nucs.solvers.backtrack_solver - Minimizing variable 8
+2024-11-12 17:27:45,644 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 80
+2024-11-12 17:27:45,677 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 75
+2024-11-12 17:27:45,677 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 73
+2024-11-12 17:27:45,678 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 72
+2024-11-12 17:27:45,679 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 70
+2024-11-12 17:27:45,682 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 68
+2024-11-12 17:27:45,687 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 66
+2024-11-12 17:27:45,693 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 62
+2024-11-12 17:27:45,717 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 60
+2024-11-12 17:27:45,977 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 55
+{
+    'ALG_BC_NB': 22652,
+    'ALG_BC_WITH_SHAVING_NB': 0,
+    'ALG_SHAVING_NB': 0,
+    'ALG_SHAVING_CHANGE_NB': 0,
+    'ALG_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 107911,
+    'PROPAGATOR_FILTER_NB': 2813035,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 1745836,
+    'PROPAGATOR_INCONSISTENCY_NB': 11289,
+    'SOLVER_BACKTRACK_NB': 11288,
+    'SOLVER_CHOICE_NB': 11353,
+    'SOLVER_CHOICE_DEPTH': 9,
+    'SOLVER_SOLUTION_NB': 10
+}
+[ 1  6 10 23 26 34 41 53 55]
+```
+
+

nucs-4.4.4/NuCS.egg-info/SOURCES.txt

@@ -0,0 +1,150 @@
+LICENSE.md
+README.md
+pyproject.toml
+NuCS.egg-info/PKG-INFO
+NuCS.egg-info/SOURCES.txt
+NuCS.egg-info/dependency_links.txt
+NuCS.egg-info/requires.txt
+NuCS.egg-info/top_level.txt
+docs/source/conf.py
+nucs/__init__.py
+nucs/constants.py
+nucs/numba_helper.py
+nucs/numpy_helper.py
+nucs/examples/__init__.py
+nucs/examples/alpha/__init__.py
+nucs/examples/alpha/__main__.py
+nucs/examples/alpha/alpha_problem.py
+nucs/examples/bibd/__init__.py
+nucs/examples/bibd/__main__.py
+nucs/examples/bibd/bibd_problem.py
+nucs/examples/donald/__init__.py
+nucs/examples/donald/__main__.py
+nucs/examples/donald/donald_problem.py
+nucs/examples/golomb/__init__.py
+nucs/examples/golomb/__main__.py
+nucs/examples/golomb/golomb_problem.py
+nucs/examples/knapsack/__init__.py
+nucs/examples/knapsack/__main__.py
+nucs/examples/knapsack/knapsack_problem.py
+nucs/examples/magic_sequence/__init__.py
+nucs/examples/magic_sequence/__main__.py
+nucs/examples/magic_sequence/magic_sequence_problem.py
+nucs/examples/magic_square/__init__.py
+nucs/examples/magic_square/__main__.py
+nucs/examples/magic_square/magic_square_problem.py
+nucs/examples/quasigroup/__init__.py
+nucs/examples/quasigroup/__main__.py
+nucs/examples/quasigroup/quasigroup_problem.py
+nucs/examples/queens/__init__.py
+nucs/examples/queens/__main__.py
+nucs/examples/queens/queens_problem.py
+nucs/examples/schur_lemma/__init__.py
+nucs/examples/schur_lemma/__main__.py
+nucs/examples/schur_lemma/schur_lemma_problem.py
+nucs/examples/sports_tournament_scheduling/__init__.py
+nucs/examples/sports_tournament_scheduling/__main__.py
+nucs/examples/sports_tournament_scheduling/sports_tournament_scheduling_problem.py
+nucs/examples/sudoku/__init__.py
+nucs/examples/sudoku/sudoku_problem.py
+nucs/examples/tsp/__init__.py
+nucs/examples/tsp/__main__.py
+nucs/examples/tsp/total_cost_propagator.py
+nucs/examples/tsp/tsp_instances.py
+nucs/examples/tsp/tsp_problem.py
+nucs/examples/tsp/tsp_var_heuristic.py
+nucs/heuristics/__init__.py
+nucs/heuristics/first_not_instantiated_var_heuristic.py
+nucs/heuristics/greatest_domain_var_heuristic.py
+nucs/heuristics/heuristics.py
+nucs/heuristics/max_regret_var_heuristic.py
+nucs/heuristics/max_value_dom_heuristic.py
+nucs/heuristics/mid_value_dom_heuristic.py
+nucs/heuristics/min_cost_dom_heuristic.py
+nucs/heuristics/min_value_dom_heuristic.py
+nucs/heuristics/smallest_domain_var_heuristic.py
+nucs/heuristics/split_high_dom_heuristic.py
+nucs/heuristics/split_low_dom_heuristic.py
+nucs/heuristics/value_dom_heuristic.py
+nucs/problems/__init__.py
+nucs/problems/circuit_problem.py
+nucs/problems/latin_square_problem.py
+nucs/problems/permutation_problem.py
+nucs/problems/problem.py
+nucs/propagators/__init__.py
+nucs/propagators/affine_eq_propagator.py
+nucs/propagators/affine_geq_propagator.py
+nucs/propagators/affine_leq_propagator.py
+nucs/propagators/alldifferent_propagator.py
+nucs/propagators/and_propagator.py
+nucs/propagators/count_eq_propagator.py
+nucs/propagators/dummy_propagator.py
+nucs/propagators/element_iv_propagator.py
+nucs/propagators/element_lic_propagator.py
+nucs/propagators/element_liv_propagator.py
+nucs/propagators/exactly_eq_propagator.py
+nucs/propagators/exactly_true_propagator.py
+nucs/propagators/gcc_propagator.py
+nucs/propagators/lexicographic_leq_propagator.py
+nucs/propagators/max_eq_propagator.py
+nucs/propagators/max_leq_propagator.py
+nucs/propagators/min_eq_propagator.py
+nucs/propagators/min_geq_propagator.py
+nucs/propagators/no_sub_cycle_propagator.py
+nucs/propagators/permutation_aux_propagator.py
+nucs/propagators/propagators.py
+nucs/propagators/relation_propagator.py
+nucs/propagators/scc_propagator.py
+nucs/solvers/__init__.py
+nucs/solvers/backtrack_solver.py
+nucs/solvers/bound_consistency_algorithm.py
+nucs/solvers/choice_points.py
+nucs/solvers/consistency_algorithms.py
+nucs/solvers/multiprocessing_solver.py
+nucs/solvers/shaving_consistency_algorithm.py
+nucs/solvers/solver.py
+tests/__init__.py
+tests/examples/test_alpha.py
+tests/examples/test_bibd.py
+tests/examples/test_donald.py
+tests/examples/test_golomb.py
+tests/examples/test_knapsack.py
+tests/examples/test_latin_square.py
+tests/examples/test_magic_sequence.py
+tests/examples/test_magic_square.py
+tests/examples/test_quasigroup.py
+tests/examples/test_queens.py
+tests/examples/test_schur_lemma.py
+tests/examples/test_sports_tournament_scheduling.py
+tests/examples/test_sudokus.py
+tests/examples/test_tsp.py
+tests/heuristics/__init__.py
+tests/heuristics/test_max_value_dom_heuristic.py
+tests/heuristics/test_mid_value_dom_heuristic.py
+tests/heuristics/test_min_value_dom_heuristic.py
+tests/problems/__init__.py
+tests/problems/test_circuit_problem.py
+tests/problems/test_permutation_problem.py
+tests/problems/test_problem.py
+tests/propagators/__init__.py
+tests/propagators/test_affine_eq.py
+tests/propagators/test_affine_geq.py
+tests/propagators/test_affine_leq.py
+tests/propagators/test_alldifferent.py
+tests/propagators/test_count_eq.py
+tests/propagators/test_element_iv.py
+tests/propagators/test_element_lic.py
+tests/propagators/test_element_liv.py
+tests/propagators/test_exactly_eq.py
+tests/propagators/test_gcc.py
+tests/propagators/test_lexicographic_leq.py
+tests/propagators/test_max_eq.py
+tests/propagators/test_max_leq.py
+tests/propagators/test_min_eq.py
+tests/propagators/test_min_geq.py
+tests/propagators/test_no_sub_cycle.py
+tests/propagators/test_relation.py
+tests/propagators/test_scc.py
+tests/solvers/__init__.py
+tests/solvers/test_backtrack_solver.py
+tests/solvers/test_multiprocessing_solver.py

nucs-4.4.4/NuCS.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

nucs-4.4.4/NuCS.egg-info/requires.txt

@@ -0,0 +1,3 @@
+numba==0.60.0
+numpy<2.1
+rich

nucs-4.4.4/NuCS.egg-info/top_level.txt

@@ -0,0 +1,6 @@
+assets
+dist
+docs
+nucs
+scripts
+tests

nucs-4.4.4/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.1
+Name: NuCS
+Version: 4.4.4
+Summary: A Numpy and Numba based Python library for solving Constraint Satisfaction Problems over finite domains
+Author-email: Yan Georget <yan.georget@gmail.com>
+Project-URL: Homepage, https://github.com/yangeorget/nucs
+Project-URL: Issues, https://github.com/yangeorget/nucs/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: numba==0.60.0
+Requires-Dist: numpy<2.1
+Requires-Dist: rich
+
+![NucS logo](https://github.com/yangeorget/nucs/blob/main/assets/nucs.png?raw=true)
+
+
+![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)
+
+![numba version](https://img.shields.io/badge/numba-v0.60-blue)
+![numpy version](https://img.shields.io/badge/numpy-v2.0-blue)
+
+![tests](https://github.com/yangeorget/nucs/actions/workflows/test.yml/badge.svg)
+![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 --log_level=INFO
+```
+```bash
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.solver - Problem has 3 propagators
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.solver - Problem has 12 variables
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+2024-11-12 17:24:49,200 - INFO - nucs.solvers.multiprocessing_solver - MultiprocessingSolver has 1 processors
+{
+    'ALG_BC_NB': 262011,
+    'ALG_BC_WITH_SHAVING_NB': 0,
+    'ALG_SHAVING_NB': 0,
+    'ALG_SHAVING_CHANGE_NB': 0,
+    'ALG_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 0,
+    'PROPAGATOR_FILTER_NB': 2269980,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 990450,
+    'PROPAGATOR_INCONSISTENCY_NB': 116806,
+    'SOLVER_BACKTRACK_NB': 131005,
+    'SOLVER_CHOICE_NB': 131005,
+    'SOLVER_CHOICE_DEPTH': 10,
+    'SOLVER_SOLUTION_NB': 14200
+}
+```
+
+### 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 --symmetry_breaking --log_level=INFO
+```
+```bash
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.solver - Problem has 462 propagators
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.solver - Problem has 504 variables
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 1
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 0
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+{
+    'ALG_BC_NB': 1425,
+    'ALG_BC_WITH_SHAVING_NB': 0,
+    'ALG_SHAVING_NB': 0,
+    'ALG_SHAVING_CHANGE_NB': 0,
+    'ALG_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 4711,
+    'PROPAGATOR_FILTER_NB': 104392,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 73792,
+    'PROPAGATOR_INCONSISTENCY_NB': 621,
+    'SOLVER_BACKTRACK_NB': 712,
+    'SOLVER_CHOICE_NB': 712,
+    'SOLVER_CHOICE_DEPTH': 19,
+    'SOLVER_SOLUTION_NB': 92
+}
+```
+
+### 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 --symmetry_breaking --log_level=INFO
+```
+```bash
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.solver - Problem has 82 propagators
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.solver - Problem has 45 variables
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 0
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 2
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+2024-11-12 17:27:45,172 - INFO - nucs.solvers.backtrack_solver - Minimizing variable 8
+2024-11-12 17:27:45,644 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 80
+2024-11-12 17:27:45,677 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 75
+2024-11-12 17:27:45,677 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 73
+2024-11-12 17:27:45,678 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 72
+2024-11-12 17:27:45,679 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 70
+2024-11-12 17:27:45,682 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 68
+2024-11-12 17:27:45,687 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 66
+2024-11-12 17:27:45,693 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 62
+2024-11-12 17:27:45,717 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 60
+2024-11-12 17:27:45,977 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 55
+{
+    'ALG_BC_NB': 22652,
+    'ALG_BC_WITH_SHAVING_NB': 0,
+    'ALG_SHAVING_NB': 0,
+    'ALG_SHAVING_CHANGE_NB': 0,
+    'ALG_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 107911,
+    'PROPAGATOR_FILTER_NB': 2813035,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 1745836,
+    'PROPAGATOR_INCONSISTENCY_NB': 11289,
+    'SOLVER_BACKTRACK_NB': 11288,
+    'SOLVER_CHOICE_NB': 11353,
+    'SOLVER_CHOICE_DEPTH': 9,
+    'SOLVER_SOLUTION_NB': 10
+}
+[ 1  6 10 23 26 34 41 53 55]
+```
+
+

nucs-4.4.4/README.md

@@ -0,0 +1,125 @@
+![NucS logo](https://github.com/yangeorget/nucs/blob/main/assets/nucs.png?raw=true)
+
+
+![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)
+
+![numba version](https://img.shields.io/badge/numba-v0.60-blue)
+![numpy version](https://img.shields.io/badge/numpy-v2.0-blue)
+
+![tests](https://github.com/yangeorget/nucs/actions/workflows/test.yml/badge.svg)
+![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 --log_level=INFO
+```
+```bash
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.solver - Problem has 3 propagators
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.solver - Problem has 12 variables
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+2024-11-12 17:24:49,200 - INFO - nucs.solvers.multiprocessing_solver - MultiprocessingSolver has 1 processors
+{
+    'ALG_BC_NB': 262011,
+    'ALG_BC_WITH_SHAVING_NB': 0,
+    'ALG_SHAVING_NB': 0,
+    'ALG_SHAVING_CHANGE_NB': 0,
+    'ALG_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 0,
+    'PROPAGATOR_FILTER_NB': 2269980,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 990450,
+    'PROPAGATOR_INCONSISTENCY_NB': 116806,
+    'SOLVER_BACKTRACK_NB': 131005,
+    'SOLVER_CHOICE_NB': 131005,
+    'SOLVER_CHOICE_DEPTH': 10,
+    'SOLVER_SOLUTION_NB': 14200
+}
+```
+
+### 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 --symmetry_breaking --log_level=INFO
+```
+```bash
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.solver - Problem has 462 propagators
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.solver - Problem has 504 variables
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 1
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 0
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+{
+    'ALG_BC_NB': 1425,
+    'ALG_BC_WITH_SHAVING_NB': 0,
+    'ALG_SHAVING_NB': 0,
+    'ALG_SHAVING_CHANGE_NB': 0,
+    'ALG_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 4711,
+    'PROPAGATOR_FILTER_NB': 104392,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 73792,
+    'PROPAGATOR_INCONSISTENCY_NB': 621,
+    'SOLVER_BACKTRACK_NB': 712,
+    'SOLVER_CHOICE_NB': 712,
+    'SOLVER_CHOICE_DEPTH': 19,
+    'SOLVER_SOLUTION_NB': 92
+}
+```
+
+### 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 --symmetry_breaking --log_level=INFO
+```
+```bash
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.solver - Problem has 82 propagators
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.solver - Problem has 45 variables
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 0
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 2
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+2024-11-12 17:27:45,172 - INFO - nucs.solvers.backtrack_solver - Minimizing variable 8
+2024-11-12 17:27:45,644 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 80
+2024-11-12 17:27:45,677 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 75
+2024-11-12 17:27:45,677 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 73
+2024-11-12 17:27:45,678 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 72
+2024-11-12 17:27:45,679 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 70
+2024-11-12 17:27:45,682 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 68
+2024-11-12 17:27:45,687 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 66
+2024-11-12 17:27:45,693 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 62
+2024-11-12 17:27:45,717 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 60
+2024-11-12 17:27:45,977 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 55
+{
+    'ALG_BC_NB': 22652,
+    'ALG_BC_WITH_SHAVING_NB': 0,
+    'ALG_SHAVING_NB': 0,
+    'ALG_SHAVING_CHANGE_NB': 0,
+    'ALG_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 107911,
+    'PROPAGATOR_FILTER_NB': 2813035,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 1745836,
+    'PROPAGATOR_INCONSISTENCY_NB': 11289,
+    'SOLVER_BACKTRACK_NB': 11288,
+    'SOLVER_CHOICE_NB': 11353,
+    'SOLVER_CHOICE_DEPTH': 9,
+    'SOLVER_SOLUTION_NB': 10
+}
+[ 1  6 10 23 26 34 41 53 55]
+```
+
+

nucs-4.4.4/docs/source/conf.py

@@ -0,0 +1,54 @@
+# Configuration file for the Sphinx documentation builder.
+
+# -- Project information
+
+project = 'NuCS'
+copyright = '2024, Yan Georget'
+author = 'Yan Georget'
+
+release = '4.4.4'
+version = '4.4.4'
+
+# -- General configuration
+
+tls_verify = False
+
+extensions = [
+    'sphinx.ext.linkcode',
+    'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx',
+]
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+}
+intersphinx_disabled_domains = ['std']
+
+templates_path = ['_templates']
+
+# -- Options for HTML output
+
+html_theme = 'sphinx_rtd_theme'
+
+html_context = {
+    "display_github": True, # Integrate GitHub
+    "github_user": "yangeorget", # Username
+    "github_repo": "nucs", # Repo name
+    "github_version": "main", # Version
+    "conf_py_path": "/docs/source/", # Path in the checkout to the docs root
+}
+
+# -- Options for EPUB output
+epub_show_urls = 'footnote'
+
+def linkcode_resolve(domain, info):
+    if domain != 'py':
+        return None
+    if info['module']:
+        filename = info['module'].replace('.', '/')
+        return f"https://github.com/yangeorget/nucs/tree/main/{filename}.py"
+    return None