sweetpea.core package¶

This module provides the fundamental functionality needed for SweetPea to actually do anything. Primarily, this involves handling data representation and making calls to external utilities for solving logic problems via SAT-solving.

Data Representation¶

SweetPea works by representing constraints on experimental designs as propositional logic formulas. These formulas are converted into conjunctive normal form and are then passed to an external SAT solver to either be solved or sampled.

Internally to core, these formulas are represented as CNF instances. These are comprised of Clauses, which are in turn comprised of Vars. The Var, Clause, and CNF classes are very expressive and can easily be used to manipulate advanced logic problems.

External Utilities¶

Once the data is in a compatible formulaic representation, it must be shipped to an external utility to be solved or sampled from. SweetPea Core makes use of the following utilities:

CryptoMiniSAT, an advanced incremental SAT solver.

Unigen, a state-of-the-art, almost-uniform sampler that uses CryptoMiniSAT.

Using Core¶

There are only a few functions exported from core, as well as a small number of classes to support using those functions.

Functions¶

cnf_is_satisfiable()

sample_non_uniform()

sample_non_uniform_from_specification()

sample_uniform()

combine_cnf_with_requests()

Classes¶

Var

Clause

CNF

AssertionType

GenerationRequest

Solution

Subpackages¶

sweetpea.core.generate package
- Subpackages
  - sweetpea.core.generate.tools package
    - Submodules
- Submodules

Submodules¶