Metadata-Version: 2.4
Name: vnuli
Version: 0.1.0
Summary: Vnuli tools for AI-assisted physical engineering investigation.
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: matplotlib>=3.8
Requires-Dist: mcp[cli]>=2
Requires-Dist: scipy>=1.12
Provides-Extra: test
Requires-Dist: pytest>=8; extra == "test"

# Vnuli

AI tools for engineers of the physical world.

Vnuli gives the AI assistant you already use tools to investigate large
engineering datasets accurately, efficiently, and traceably.

## Current Status

Prototype 0.5 is complete with final disposition **PASS**. Vnuli Product
Foundation Phase 1 is in progress to make the installed product identity
coherently Vnuli before Prototype 0.6 external engineer validation.

Authoritative current planning documents:

- Product Foundation roadmap: `docs/vnuli-product-foundation-roadmap.md`
- Product Foundation implementation contract:
  `docs/vnuli-product-foundation-implementation-contract.md`
- Product Foundation Phase 0 closeout:
  `docs/vnuli-product-foundation-phase-0-closeout.md`
- Product Foundation Phase 1 task list:
  `docs/vnuli-product-foundation-phase-1-executable-task-list.md`

Historical Prototype 0.x documents remain in `docs/` and `docs/Old/`. They may
retain earlier names where historically accurate.

## Current Installed-Product Identity

The normal Phase 1 product identity is:

```text
Distribution:  vnuli
Import:        vnuli
CLI:           vnuli
MCP server:    Vnuli
```

Current command surface:

```powershell
vnuli --help
vnuli --version
vnuli serve
```

`vnuli serve` starts the local stdio MCP server. Product-facing MCP client
installation and `vnuli mcp ...` commands belong to a later Product Foundation
phase.

## Developer Setup

Use Python 3.12 from the repository root.

```powershell
python -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install -e .[test]
pytest
```

Verify the local development import:

```powershell
python -c "import vnuli; import vnuli.analysis.plotting; print('install ok')"
```

## Runtime Configuration Boundary

The current runtime still uses the Prototype 0.5 configuration mechanism:

```text
TEST_INTELLIGENCE_CONFIG
```

If this variable is unset or blank, Vnuli uses packaged synthetic sample data.
If it points to an invalid configuration or missing dataset file, startup fails
instead of silently falling back.

Vnuli-owned configuration, `vnuli setup`, and `vnuli data ...` belong to later
Product Foundation phases.

## Historical MCP Configuration

The checked-in `.vscode/mcp.json` is retained as historical/source-checkout MCP
integration evidence. Product-facing MCP client installation belongs to a later
Product Foundation phase and should not be inferred from that historical file.
