{"id":16613160,"url":"https://github.com/c-cube/sidekick","last_synced_at":"2025-08-22T12:15:30.910Z","repository":{"id":45171609,"uuid":"118384563","full_name":"c-cube/sidekick","owner":"c-cube","description":"A modular library for CDCL(T) SMT solvers, with [wip] proof generation.","archived":false,"fork":false,"pushed_at":"2025-01-28T02:52:07.000Z","size":16177,"stargazers_count":24,"open_issues_count":7,"forks_count":15,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-07T01:45:10.996Z","etag":null,"topics":["cdcl-t","congruence-closure","formal-methods","functor","prover","sat-solver","smt-solver"],"latest_commit_sha":null,"homepage":"https://c-cube.github.io/sidekick/","language":"SMT","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/c-cube.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-01-21T23:52:28.000Z","updated_at":"2025-01-28T02:49:20.000Z","dependencies_parsed_at":"2023-12-07T06:23:01.222Z","dependency_job_id":"57b29e7a-d262-46ac-a161-b2ece386f4e4","html_url":"https://github.com/c-cube/sidekick","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c-cube%2Fsidekick","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c-cube%2Fsidekick/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c-cube%2Fsidekick/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c-cube%2Fsidekick/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/c-cube","download_url":"https://codeload.github.com/c-cube/sidekick/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242940018,"owners_count":20209883,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cdcl-t","congruence-closure","formal-methods","functor","prover","sat-solver","smt-solver"],"created_at":"2024-10-12T01:46:09.538Z","updated_at":"2025-03-10T22:58:53.993Z","avatar_url":"https://github.com/c-cube.png","language":"SMT","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sidekick [![Build](https://github.com/c-cube/sidekick/actions/workflows/main.yml/badge.svg)](https://github.com/c-cube/sidekick/actions/workflows/main.yml)\n\nSidekick is an OCaml library for creating SMT solvers following\nthe CDCL(T) approach (so called \"lazy SMT\"). See [below](#short-summary)\nfor a more detailed explanation.\n\nIt derives from [Alt-Ergo Zero](http://cubicle.lri.fr/alt-ergo-zero)\nand its fork [mSAT](https://github.com/gbury/msat).\n\n## Documentation\n\nSee [the API documentation](https://c-cube.github.io/sidekick/).\n\nA work-in-progress [guide](doc/guide.md) provides a more step-by-step\nintroduction to how to use and modify sidekick.\n\n## Short summary\n\n[SMT solvers](https://en.wikipedia.org/wiki/Satisfiability_modulo_theories)\nare automatic tools that try to assess whether a given logic formula is\n*satisfiable* (admits a model, an interpretation that makes it true)\nor *unsatisfiable* (no interpretation can make it true; it is absurd, and its\nnegation is a theorem). Prominent solvers include [Z3](https://github.com/Z3Prover/z3),\n[cvc5](https://cvc5.github.io/), [Yices 2](https://github.com/SRI-CSL/yices2/),\nand others; all of them follow the **CDCL(T)** paradigm.\nMost of these solvers are implemented in C or C++.\n\nCDCL(T) is the combination of [CDCL](https://en.wikipedia.org/wiki/Conflict-driven_clause_learning),\nthe leading technique for SAT solving (as popularized by Chaff, minisat, etc.\nin the early oughties), and a **theory** T. In practice, SMT solvers _combine_\nmultiple theories into one before doing the combination with the SAT solver.\nSome examples of theories are uninterpreted functions symbols, integer linear\narithmetic (\"LIA\"), rational nonlinear arithmetic (\"NRA\"), bitvectors for fixed-size\narithmetic, algebraic datatypes, and others.\n\nSidekick is a CDCL(T) solver implemented in pure [OCaml](https://ocaml.org/)\nand with a strong focus on modularity and reusability of components.\nIt _used to_ provide a functorized interface, but it now comes with its own\nrepresentation of terms, in a simple version of the Calculus of Constructions.\nUsers can extend that term representation by adding new custom _constants_\nto model their domain theories. Most of the constants defined in sidekick are\ndefined exactly as outside constants would be.\n\nSidekick comes in several components (as in, opam packages):\n\n- `sidekick` is the core library, with core type definitions (see `src/core/`),\n  an implementation of CDCL(T) based on [mSat](https://github.com/Gbury/mSAT/),\n  a congruence closure, and the theories of boolean formulas, LRA (linear rational\n  arithmetic, using a simplex algorithm), and datatypes.\n- `sidekick-base` is a library with concrete implementations for terms,\n  arithmetic functions, and proofs.\n  It comes with an additional dependency on\n  [zarith](https://github.com/ocaml/Zarith) to represent numbers (zarith is a\n  GMP wrapper for arbitrary precision numbers).\n- `sidekick-bin` is an executable that is able to parse problems in\n  the SMT-LIB-2.6 format, in the `QF_UFLRA` fragment, and solves them using\n  `sidekick` instantiated with `sidekick-base`.\n  It is mostly useful as a test tool for the libraries and as a starting point\n  for writing custom solvers.\n\n## Installation\n\n### Via opam\n\nOnce the package is on [opam](http://opam.ocaml.org), just `opam install sidekick`.\nFor the development version, use:\n\n    opam pin https://github.com/c-cube/sidekick.git\n\n### Manual installation\n\nYou will need dune . The command is:\n\n    make install\n\n## Copyright\n\nThis program is distributed under the Apache Software License version\n2.0. See the enclosed file `LICENSE`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fc-cube%2Fsidekick","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fc-cube%2Fsidekick","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fc-cube%2Fsidekick/lists"}