Getting Started

Getting Started

This page helps you choose the right install path.

Use the pip install path when you want practical checks, schema export, bundled demos, Phase Ecology Lab diagnostics, and your own JSON or text inputs.

Use the source checkout path when you need the full examples/... tree, development tests, canonical TeX audits, or release engineering.

Option 1: pip Install

This is the normal starting point for most users.

python -m pip install percolation-inversion-compiler
pic agent explain
pic agent check --compact --text "Candidate packet: preserve residuals." --profile development
pic phase plan --compact --text "Candidate packet: preserve residuals." --profile development
pic demo installed-smoke --profile development
pic demo bootstrap --output-dir pic-demo

Then run the packaged Phase Lab demo:

pic phase lab init --output-dir pic-demo/phase-lab
pic phase lab ingest --store pic-demo/phase-lab --report pic-demo/phase_lab_runtime_report.json
pic phase lab observe --store pic-demo/phase-lab --window latest
pic phase lab graph --store pic-demo/phase-lab
pic phase lab closure --store pic-demo/phase-lab
pic phase lab executable-paths --store pic-demo/phase-lab
pic phase lab certify --store pic-demo/phase-lab --threshold pic-demo/phase_lab_threshold.json

The core install is enough for compact checks, bundled demos, schemas, snapshots, and Phase Lab diagnostics.

Use optional extras when you need identity checks, live connector support, or the local service layer:

python -m pip install "percolation-inversion-compiler[identity,connectors,server]"

Option 2: Source Checkout

Use this when you want repository fixtures, examples, full development checks, or canonical audits.

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
git clone https://github.com/kadubon/percolation-inversion-compiler.git
cd percolation-inversion-compiler
uv sync --all-extras --dev

macOS and Linux uv install:

curl -LsSf https://astral.sh/uv/install.sh | sh

Fallback uv install:

python -m pip install uv

Then run commands through uv run:

uv run pic agent check --compact --text "Candidate packet: preserve residuals." --profile development
uv run pic phase lab init --output-dir pic-phase-lab
uv run pic phase lab ingest --store pic-phase-lab --report examples/phase_lab/runtime_report_1.json
uv run pic phase lab graph --store pic-phase-lab

What To Read First

• Quickstart for the shortest command paths.
• Phase Ecology Lab for v0.5.0 diagnostics.
• Core Concepts for the terms used in reports.
• Safety and Limits before treating any output as authority.

First Interpretation Rule

PIC is fail-closed. accepted=true does not mean "go execute this." settled=false does not mean "the command failed." It usually means useful diagnostics were produced while unresolved work stayed visible.