PySAT Documentation

The PySAT toolkit is organized into seven core modules. These are divided into two categories based on their implementation:

Pure Python Modules

These modules are implemented entirely in Python:

• .engines
• .formula
• .integer

C/C++ Python Wrappers

These modules provide Python interfaces to high-performance code originally implemented in C/C++:

• .card
• .pb (a wrapper for PyPBLib functionality)
• .process
• .solvers

Standard News

• The first post in /content/en/news is automatically highlighted on the front page. To disable this, remove the /content/en/news folder.
• News items link to the /news category page by default. To change this, set newsLink in the post's preamble.

Single Page News

Instead of using a folder for posts, you can list all news items on a single page using /news.md. To ensure the front page banner is populated, set the newsHeader parameter in the preamble of /news.md.

The .examples package contains scripts designed to demonstrate practical problem-solving using the toolkit. It includes implementations for:

• Formula generation
• MaxSAT solvers (including RC2)
• (S)MUS extractors and enumerators
• MCS enumerators

PySAT uses a rolling release model. Instead of infrequent major releases, the toolkit receives many small, frequent updates. To ensure you have the latest bug fixes, solver support, and performance improvements, it is recommended to upgrade your installation periodically.

Refer to the installation guide for specific upgrade instructions.

You can add custom Material-UI SVGs to the /assets/icons directory.

• In the footer: Icons are used automatically following the theme's built-in pattern.
• In Hugo templates: Use the svg-icon partial to display an icon. For example, to display /assets/icons/my-icon.svg, use:

{{ partial "svg-icon" "my-icon" }}

To generate the static HTML files for your website, run the following command. The output will be placed in the ./public directory.

make html

To set up a new website using the Scientific Python Hugo Theme, follow these steps:

1. Prerequisites: Ensure Hugo is installed and available in your system path.
2. Template Setup: Download the theme ZIP file, extract it, and copy the doc folder to your new project directory.
3. Git Submodule: Initialize a git repository in your project and add the theme as a submodule to manage updates.
4. Launch: Use make serve to start a local development server.

# 1. Copy the doc folder as a template
cp -r scientific-python-hugo-theme-main/doc ./my-website
cd my-website

# 2. Initialize git and add the theme as a submodule
git init
git submodule add https://github.com/scientific-python/scientific-python-hugo-theme themes/scientific-python-hugo-theme

# 3. Build and serve the site
make serve

The tools/team_query.py script fetches team member data from GitHub.

Requirements:

• Set the GH_TOKEN environment variable to a valid GitHub personal access token.

Usage: Run the script to generate a Markdown file containing team information, which can then be rendered using team and team_member shortcodes.

python team_query.py --org scientific-python --team spec-steering-committee --title "Spec Steering Committee" > content/en/teams/spec-steering-committee.md

You can customize the theme by overriding specific partial templates. The following partials are available for overriding:

• post_meta.html: Used to render meta-data (like author or date) under a post title.
• footer_actions: Used to add content to the right-hand side of the footer (e.g., mailing list subscriptions).