Metadata-Version: 2.4
Name: food-simulation-sdk
Version: 0.1.0
Summary: A deterministic and explainable SDK for modeling culinary processes.
Keywords: simulation,food,culinary,deterministic,sdk
License-Expression: Apache-2.0
License-File: LICENSE
License-File: NOTICE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Dist: fastapi>=0.139,<0.140
Requires-Dist: jsonschema>=4.26,<5
Requires-Dist: uvicorn>=0.51,<0.52
Requires-Python: >=3.14, <3.15
Project-URL: Documentation, https://github.com/a-class-olegb/food-simulation-platform/blob/main/docs/consumer/README.md
Project-URL: Issues, https://github.com/a-class-olegb/food-simulation-platform/issues
Project-URL: Repository, https://github.com/a-class-olegb/food-simulation-platform
Description-Content-Type: text/markdown

# Food Simulation Platform

Food Simulation Platform — рабочее название независимой платформы для описания и исполнения кулинарных процессов. Её поставляемое разработчикам ядро называется **Food Simulation SDK**.

## Текущий статус

- Этап: `A9 — Hardening and Release`.
- Состояние: A1–A9 и Gate A завершены; готовится подписанный публичный release SDK `0.1.0`.
- Производственный код: готовы immutable domain boundary, embedded schemas и
  Knowledge Pack, injected facade, deterministic rule selection и pure
  form/transfer/combine/split/thermal operators, единый session step,
  canonical CookingProgram executor, log compiler, semantic Result compare и
  reviewed runtime-neutral golden vector harness для пяти end-to-end scenarios,
  offline CLI inspection/validation, единые library/CLI operations
  `simulate`, `replay`, `compare`, black-box clean-install flow wheel/sdist и
  stateless FastAPI adapter с exact OpenAPI route surface, executable
  library/CLI/API equivalence, loopback-only `food-simulation-api`, bounded
  timeout/concurrency и clean-install Python/curl quickstarts; принят typed
  React/Vite Simulation Lab с проверенными Causal Workbench и Lab Bench,
  catalog/program composer, реальным run, полным state/DishState timeline и
  selectable typed causal trace, Review Corridor через публичный semantic
  compare и standard golden-vector ZIP с проверяемым import/replay; отдельный
  versioned Localization Pack, public SDK resolver и полностью двуязычный
  English/Russian интерфейс не изменяют stable IDs и canonical artifacts;
  consumer documentation даёт единый clean-install путь, public API reference,
  tutorials и исполняемые library/data/CLI/API examples с явной границей
  technical prototype.
- Текущая цель: выпустить подписанный SDK `0.1.0` через GitHub Release и
  PyPI trusted publishing без запуска Stage B.

Актуальное состояние находится в [docs/project/status.md](docs/project/status.md).

## Локальная установка

Проект использует CPython 3.14.6 и `uv 0.11.30`. Единственная поддерживаемая последовательность первой установки и ежедневных команд описана в [руководстве по локальной среде](docs/development/local-environment.md). Системный Python и глобальные Python-пакеты не требуются.

После установки полный локальный контур запускается одной командой:

```bash
./scripts/check all
```

## Состав продукта

- **Food Simulation Platform** — платформа целиком.
- **Food Simulation SDK** — библиотека, схемы и инструменты разработчика.
- **Food Simulation Core / Runtime** — детерминированное вычислительное ядро.
- **Food Knowledge Pack** — версионируемые кулинарные данные и правила.
- **Simulation Lab** — первый референсный клиент SDK.
- **Culinary Game** — отдельный будущий клиент платформы.

## Навигация

- [Индекс документации](docs/README.md)
- [Quickstart и документация потребителя SDK](docs/consumer/README.md)
- [Генеральный план](docs/project/master-plan.md)
- [Видение продукта](docs/product/vision.md)
- [Доменная модель](docs/domain/model.md)
- [Контрольные ворота](docs/project/stage-gates.md)
- [Готовность и evidence Gate A](docs/project/gates/gate-a-readiness.md)
- [Правила управления проектом](docs/project/governance.md)
- [Границы этапа A](docs/product/scope-stage-a.md)
- [Матрица миграции исходных документов](docs/project/migration-matrix.md)
- [Стратегия тестирования](docs/development/testing-strategy.md)
- [Локальная среда разработки](docs/development/local-environment.md)
- [Локальные проверки качества](docs/development/quality-gates.md)
- [Базовый контур безопасности](docs/development/security-baseline.md)
- [Релизный threat, dependency, SBOM и license review](docs/development/release-security-review.md)
- [Reproducible release pipeline](docs/development/release-pipeline.md)
- [Подписанный public SDK release](docs/development/public-release.md)
- [Release notes SDK 0.1.0](docs/releases/sdk-0.1.0.md)
- [Apache-2.0 license](LICENSE)
- [Политика безопасности](SECURITY.md)
- [Definition of Done](docs/development/definition-of-done.md)
- [Архитектурные решения](docs/architecture/adr/README.md)
- [Knowledge planning baseline](knowledge/README.md)
- [Embedded Food Knowledge Pack](docs/development/knowledge-package.md)
- [SimulationFacade и runtime ports](docs/development/runtime-facade.md)
- [Runtime validation и выбор правил](docs/development/rule-selection.md)
- [Form, transfer и material ledger](docs/development/material-transitions.md)
- [Combine, split и aggregation policy](docs/development/composition-operations.md)
- [Reference thermal/moisture model](docs/development/reference-thermal-model.md)
- [Session и CookingProgram execution](docs/development/session-program-execution.md)
- [Пять runtime acceptance scenarios](docs/development/runtime-acceptance-scenarios.md)
- [Trace completeness invariants](docs/development/trace-completeness.md)
- [Canonical SimulationResult](docs/development/canonical-result.md)
- [Semantic Result compare](docs/development/semantic-compare.md)
- [Golden vector harness](docs/development/golden-vectors.md)
- [CLI contract и diagnostic UX](docs/development/cli-contract.md)
- [CLI inspect и validate](docs/development/cli-inspect-validate.md)
- [CLI simulate, replay и compare](docs/development/cli-simulate-replay-compare.md)
- [Clean-install CLI quickstart](docs/development/cli-quickstart.md)
- [Service API и OpenAPI contract](docs/interfaces/service-api.md)
- [Тонкий Service API adapter](docs/development/service-api-adapter.md)
- [Library, CLI и API equivalence](docs/development/interface-equivalence.md)
- [Локальный Service API quickstart](docs/development/api-quickstart.md)
- [UX flow Simulation Lab](docs/clients/simulation-lab-flow.md)
- [Разработка Simulation Lab](docs/development/simulation-lab-prototype.md)
- [Catalog и Scenario Composer](docs/development/simulation-lab-composer.md)
- [Run и causal trace](docs/development/simulation-lab-run-trace.md)
- [Compare и regression export](docs/development/simulation-lab-review-corridor.md)
- [Платформенная локализация](docs/development/localization-platform.md)

## Принцип реализации

Сначала создаётся независимый, проверяемый и расширяемый язык приготовления пищи и среда его исполнения. Затем эта платформа используется клиентами, включая кулинарную игру.

Проект не переходит к следующему этапу по календарю. Переход разрешается только после прохождения соответствующих контрольных ворот и появления проверяемых свидетельств готовности.
