Conjure Oxide

This repository contains the in-progress Conjure Oxide constraints modelling tool and its dependencies.

https://github.com/conjure-cp/conjure-oxide

The documentation and Conjure Oxide reports can be found at https://conjure-cp.github.io/conjure-oxide-reports/.

Installation

Building from Source

The following dependencies are required:

• Conjure (including solvers)
• Clang
• Libclang
• Cmake
• Rust, installed using rustup

Ensure that Conjure is placed early in your PATH to avoid conflicts with ImageMagick's conjure command!

Run make install to build and install conjure-oxide to ~/.cargo/bin, and ensure ~/.cargo/bin is in your PATH. make test prepends ~/.cargo/bin automatically. If you prefer Cargo directly, use cargo install --path crates/conjure-cp-cli.

For more information about installation, visit our documentation installation page.

Repository Structure

This repository holds the source-code for both conjure-oxide itself, and various related projects.

conjure-oxide crates

The following crates define the conjure-oxide system:

• conjure-cp defines conjure-oxide as a library. It re-exports symbols from the following internal crates:

  • conjure-cp-core
  • conjure-cp-enum-compatibility-macro
  • conjure-cp-essence-macros
  • conjure-cp-essence-parser
  • conjure-cp-rule-macros

• conjure-cp-cli implements the conjure-oxide command line interface, and exports various CLI related utilities for use by the integration tester.

• conjure-cp-rules defines the default rewrite rules used by conjure-oxide.

• test-suite is an internal crate containing integration tests for conjure-oxide.

• conjure-cp-lsp implements the language server for use in a VSCode extension (as outlined in Language Server Protocol) for conjure-oxide.

Ecosystem crates

The following crates are related to, or used by, conjure-oxide, but can be used in isolation from it:

• minion-sys defines FFI bindings for the Minion CP solver.
• tree-morph provides a framework for implementing term-rewriting systems.
• tree-sitter-essence defines a tree-sitter grammar for Essence.
• randicheck

Related Projects

The following projects are used by, and developed alongside, conjure-oxide, but are kept in their own repositories:

• uniplate
• polyquine

Licence

This project is being produced by staff and students of University of St Andrews, and is licenced under the Mozilla Public Licence 2.0.