Skip to main content

VERITAS — AI Critique Experimental Report Analysis Framework

Project description

VERITAS v2.2

Experimental Report Analysis Engine

CI Python 3.10+ License: MIT Coverage Tests

A sovereignty-grade experimental report critique engine.
Implements the VERITAS v2.2 protocol as a fully executable Python package + REST API + CLI.


What It Does

Accepts a raw experimental report (text, PDF, DOCX, MD) and produces a structured critique through a 7-phase pipeline, enriched with LOGOS reasoning, HSTA scoring, bibliography analysis, and reproducibility assessment.

Phase Name Weight
PRECHECK Artifact Sufficiency Gate
STEP 0 Experiment Classification
STEP 1 Claim Integrity 40%
STEP 2 Traceability Audit 30%
STEP 3 Series Continuity 20%
STEP 4 Publication Readiness 10%
STEP 5 Priority Fix Synthesis

Output enrichment layers:

Engine Output Description
LOGOS IRF-Calc 6D irf_scores M/A/D/I/F/P reasoning quality dimensions
BioMedical-Paper-Harvester HSTA hsta_scores N/C/T/R bibliometric quality
BibliographyAnalyzer bibliography_stats Reference count, formats, year range, quality score
ReproducibilityChecklistExtractor reproducibility_checklist 8-criterion ARRIVE/CONSORT assessment

Quick Start

pip install veritas

Python API

from veritas import veritasCritiqueEngine

engine = SciExpCritiqueEngine()
report = engine.critique(report_text)

print(report.precheck.line1)          # PRECHECK MODE: FULL
print(report.omega_score)             # 0.8571
print(report.irf_scores.composite)    # LOGOS IRF composite
print(report.bibliography_stats.quality_score)

CLI

# Critique from file (output to terminal as Markdown)
veritas critique path/to/report.pdf

# Critique and save formatted report
veritas critique report.pdf --format docx --output report_critique.docx
veritas critique report.pdf --format pdf  --output report_critique.pdf
veritas critique report.pdf --format tex  --output report_critique.tex
veritas critique report.pdf --format md   --output report_critique.md

# Use KU Research Report template
veritas critique report.pdf --template ku --format docx

# Run PRECHECK gate only
veritas precheck report.pdf

# MICA Playbook mode — structured JSON for agent/skill pipelines
veritas critique report.pdf --mica

REST API

# Start the server
uvicorn veritas.api.app:app --reload --port 8400

# Submit text
curl -X POST http://localhost:8400/api/v1/critique/text \
  -H "Content-Type: application/json" \
  -d '{"report_text": "...", "template": "bmj", "round_number": 1}'

# Upload a document
curl -X POST http://localhost:8400/api/v1/critique/upload \
  -F "file=@report.pdf" -F "template=bmj"

# Download formatted report
curl -X POST http://localhost:8400/api/v1/critique/download \
  -F "file=@report.pdf" -F "format=docx" -o critique.docx

Output Formats

Format Flag Description
Markdown --format md Structured .md with tables (low token cost)
DOCX --format docx A4 professional report (python-docx)
PDF --format pdf A4 print-ready (ReportLab)
LaTeX --format tex Standalone .tex (XeLaTeX-compatible, optional compile_pdf)

All outputs use either the BMJ Scientific Editing template or the KU Research Report template (--template bmj|ku).


API Endpoints

Method Path Description
POST /api/v1/critique/text Full critique pipeline (JSON body)
POST /api/v1/critique/upload Full critique pipeline (file upload)
POST /api/v1/critique/download Upload file, receive formatted report
POST /api/v1/precheck PRECHECK gate only
POST /api/v1/classify STEP 0 classification only
GET /health Liveness check
GET /version Package version

See docs/api_reference.md for full schema.


Enrichment Engines

LOGOS IRF-Calc 6D

Six-dimensional reasoning quality score computed over the critique text:

Dimension Key Meaning
Methodic Doubt M Systematic uncertainty articulation
Axiom / Hypothesis A Central claim falsifiability
Deduction D Logical step validity
Induction I Evidence generalization quality
Falsification F Testability and counter-evidence exposure
Paradigm P Framework consistency
Composite Mean of M+A+D+I+F+P; threshold ≥ 0.78 = PASS

HSTA 4D (BioMedical-Paper-Harvester)

Four-dimensional bibliometric score:

Dimension Key Meaning
Novelty N Unique technical term density
Consistency C Contradiction marker absence
Temporality T Version / date marker presence
Reproducibility R Method detail completeness
Composite Arithmetic mean (N+C+T+R)/4

Bibliography Analysis

Extracted automatically from the reference section of the submitted document:

  • Total reference count and format detection (Vancouver / APA / Harvard)
  • Year range (oldest → newest)
  • Self-citation detection
  • Quality score: 0.0–1.0 composite (recency 50% + breadth 50%, −10% if self-cites detected)

Reproducibility Checklist

8-criterion assessment derived from ARRIVE 2.0 / CONSORT 2010 / STROBE / TOP Guidelines:

Code Criterion
DATA Open data availability statement
CODE Code / software availability
PREREG Pre-registration declaration
POWER Statistical power / sample size justification
STATS Statistics description (test, software, version)
BLIND Blinding / randomization procedure
EXCL Exclusion criteria stated
CONF Conflict of interest declaration

PRECHECK Modes

FULL     — All artifacts present. Execute STEP 0 through STEP 5 normally.
PARTIAL  — Primary claim evaluable; secondary artifacts missing. Proceed, mark gaps.
LIMITED  — Primary claim partially evaluable. Constrained execution.
BLOCKED  — Insufficient material. Critique halted after PRECHECK.

Traceability Classes

The engine uses exactly three traceability terms (no weaker substitutes):

Class Meaning
traceable Fully anchored to a measured artifact
partially traceable Some anchoring present; incomplete
not traceable No artifact anchor found

Evidence Precedence

Conflicting artifacts are resolved by rank:

  1. Measured artifact / raw result file
  2. Hash manifest / trace log / deviation log
  3. Inline figure or table
  4. Narrative interpretation
  5. Cross-cycle comparison prose

MICA Playbook Mode

The CLI supports MICA (Memory Invocation & Context Archive) structured output for agent / skill pipeline integration:

veritas critique report.pdf --mica

Returns a machine-readable JSON payload suitable for direct consumption by AI agents, orchestrators, or downstream skills — without token overhead of formatted prose.


Development

git clone <repo>
cd veritas
pip install -e ".[dev]"

pytest                          # full suite + 80% coverage gate
ruff check src tests            # lint
mypy src                        # type check

Architecture

See docs/architecture.md.


License

MIT © Flamehaven

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flamehaven_veritas-2.2.0.tar.gz (62.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flamehaven_veritas-2.2.0-py3-none-any.whl (69.9 kB view details)

Uploaded Python 3

File details

Details for the file flamehaven_veritas-2.2.0.tar.gz.

File metadata

  • Download URL: flamehaven_veritas-2.2.0.tar.gz
  • Upload date:
  • Size: 62.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for flamehaven_veritas-2.2.0.tar.gz
Algorithm Hash digest
SHA256 01756abb19d80f6aebb812a0f30d747579cb6a8ff8317e3c6750796d3665f815
MD5 9ba6a795a46b2792ff5b06fd665d860f
BLAKE2b-256 38126e85978b787e50070b0d598de1aa2a355f4eb00aa12c7d3ef98ec8f75f45

See more details on using hashes here.

Provenance

The following attestation bundles were made for flamehaven_veritas-2.2.0.tar.gz:

Publisher: release.yml on flamehaven01/Flamehaven-Veritas

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file flamehaven_veritas-2.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for flamehaven_veritas-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2834e3c5768320f97b62356fb63b56aeb223adb9081657778c425d1c78f9a4a2
MD5 d8b083827bb3e5d40e9f6c1badcdef07
BLAKE2b-256 fbd7ed605de070e32194b1a42fe93d76e1968ae4c24dccdd01d2ae4d26eea84d

See more details on using hashes here.

Provenance

The following attestation bundles were made for flamehaven_veritas-2.2.0-py3-none-any.whl:

Publisher: release.yml on flamehaven01/Flamehaven-Veritas

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page