Metadata-Version: 2.4
Name: chirality-framework
Version: 15.0.0
Summary: CF14 Semantic Calculator - Fixed canonical algorithm for structured problem-solving
Author: Chirality Framework Team
Maintainer: Chirality Framework Team
License: MIT
Project-URL: Homepage, https://github.com/sgttomas/chirality-framework
Project-URL: Repository, https://github.com/sgttomas/chirality-framework.git
Project-URL: Issues, https://github.com/sgttomas/chirality-framework/issues
Project-URL: Documentation, https://github.com/sgttomas/chirality-framework/blob/main/README.md
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.0.0
Requires-Dist: python-dotenv>=1.0.0
Provides-Extra: openai
Requires-Dist: openai>=1.0.0; extra == "openai"
Provides-Extra: neo4j
Requires-Dist: neo4j>=5.0.0; extra == "neo4j"
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: black>=22.0.0; extra == "dev"
Requires-Dist: mypy>=1.0.0; extra == "dev"
Provides-Extra: all
Requires-Dist: openai>=1.0.0; extra == "all"
Requires-Dist: neo4j>=5.0.0; extra == "all"
Dynamic: license-file

# Chirality Framework: A Semantic Calculator

**Version: 15.0.0** | **Status: Refactored to Canonical Algorithm**

The Chirality Framework is a direct, simple, and observable implementation of a fixed, canonical algorithm for structured problem-solving. It is not a general-purpose framework but a "semantic calculator" designed to execute a specific sequence of semantic transformations.

The value of this project is in the unique, insightful **output** of the calculation, not in the flexibility of the code.

## Core Concept: The Three-Stage Interpretation Pipeline

The heart of the Chirality Framework is a three-stage process that generates deep meaning from fixed inputs:

1.  **Stage 1 (Combinatorial):** Mechanical combination of terms.
2.  **Stage 2 (Semantic Resolution):** An LLM resolves the raw terms into meaningful concepts.
3.  **Stage 3 (Ontological Lensing):** The LLM interprets these concepts through the contextual lens of the framework's ontological axes.

For a complete technical description of this process, see the **[Canonical Algorithm Documentation](docs/ALGORITHM.md)**.

## Quick Start: Using the CLI

The primary way to interact with the calculator is via the command-line interface. The most common command is `compute-cell`, which allows you to observe the 3-stage pipeline for any cell in a matrix.

### Prerequisites
- Python 3.8+
- An OpenAI API key set as the `OPENAI_API_KEY` environment variable.

### Examples: Computing cells through the 3-stage pipeline

```bash
# Navigate to the project root
cd /path/to/chirality-framework

# Compute cell C[0,0] with verbose output (shows all 3 stages)
python3 -m chirality.cli compute-cell C --i 0 --j 0 --verbose

# Compute with OpenAI resolver (requires API key)
python3 -m chirality.cli compute-cell C --i 0 --j 0 --resolver openai --verbose

# Compute different matrix types
python3 -m chirality.cli compute-cell F --i 1 --j 2 --verbose
python3 -m chirality.cli compute-cell D --i 2 --j 1 --problem "creating value"

# Enable tracing for full observability
python3 -m chirality.cli compute-cell C --i 0 --j 0 --trace --verbose

# Get help and information
python3 -m chirality.cli --help
python3 -m chirality.cli info
```

This will display the output of all three stages for the specified cell.

## Development

To set up the development environment and run tests, please refer to the instructions in `CONTRIBUTING.md`.
