# Axmo

> Axmo is a multi-dimensional modelling add-in for Microsoft Excel. A model is one YAML file (`model.yaml`, inside an
> `.axmo` container): dimensions, data series with formulas, data sources and loaders, output ranges. This pack is
> what an AI needs to write, check and amend one.

Open the links one at a time, after this file has loaded.

Format version: ed0892bbbdf4. Generated by `npm run gen:ai-pack` (scripts/ai-pack.ts) — do not edit.

## Everything in one file

- [llms-full.txt](https://axmo.it/llms-full.txt): everything needed to write a model, in one fetch — the skill, the guide's parts and the capability table as plain text, every link absolute

## The format

- [JSON Schema](https://axmo.it/ai/generated/axmo-model.schema.json): the shape of a model.yaml
- [Keys](https://axmo.it/ai/generated/axmo-model-yaml-keys.json): every key, per level
- [Functions](https://axmo.it/ai/generated/functions.md): the formula functions and naming rules
- [Dimensional expressions](https://axmo.it/ai/generated/dimensional-expressions.md): sets, anchors, WHERE and computed positions, each with tested examples

## Checking a model

- [Report forms](https://axmo.it/ai/generated/message-forms.md): the import report, line by line — what Copy report gives a chat
- [Error codes](https://axmo.it/ai/generated/error-codes.md): every code a report line carries
- [Check tool](https://axmo.it/ai/tool/axmo-check.mjs): node axmo-check.mjs model.axmo [--values] [--series <name>]
- [Shape check](https://axmo.it/ai/tool/axmo-shape-check.mjs): node axmo-shape-check.mjs model.axmo (schema only)
- [Workbook tool](https://axmo.it/ai/tool/axmo-workbook.mjs): node axmo-workbook.mjs extract book.xlsx | apply book.xlsx model.yaml -o new.xlsx
- [Agent Skill](https://axmo.it/ai/axmo-model-check-skill.zip): the tools and the skill instructions, zipped

## The guide

How to build a model, step by step. Read every part: each states what the others assume.

- [Building Axmo models — the guide](https://axmo.it/ai/guide/README.md)
- [The method](https://axmo.it/ai/guide/01-method.md)
- [Writing the model file](https://axmo.it/ai/guide/02-model-file.md)
- [Formulas, and how series total up](https://axmo.it/ai/guide/03-formulas-and-totals.md)
- [Recipes](https://axmo.it/ai/guide/04-recipes.md)
- [Checking a model, and fixing what the report says](https://axmo.it/ai/guide/05-checking-and-fixing.md)
- [What Axmo can do with a model's data — the capability table](https://axmo.it/ai/capabilities.md): what works with a model's data, measured, and what does not

## Recipes

Worked models (their expected values are in the guide's recipes part), each as its model.yaml in text:

- [actual-vs-budget](https://axmo.it/ai/recipes/actual-vs-budget.model.yaml)
- [budget-split](https://axmo.it/ai/recipes/budget-split.model.yaml)
- [cash-balance](https://axmo.it/ai/recipes/cash-balance.model.yaml)
- [cost-centre-report](https://axmo.it/ai/recipes/cost-centre-report.model.yaml)
- [formula-forms](https://axmo.it/ai/recipes/formula-forms.model.yaml)
- [fx-conversion](https://axmo.it/ai/recipes/fx-conversion.model.yaml)
- [generated-dimension](https://axmo.it/ai/recipes/generated-dimension.model.yaml)
- [intro](https://axmo.it/ai/recipes/intro.model.yaml)
- [kitchenware-production](https://axmo.it/ai/recipes/kitchenware-production.model.yaml)
- [loan-outstanding](https://axmo.it/ai/recipes/loan-outstanding.model.yaml)
- [pl-from-ledger](https://axmo.it/ai/recipes/pl-from-ledger.model.yaml)
- [pricing-and-margins](https://axmo.it/ai/recipes/pricing-and-margins.model.yaml)
- [walkthrough-demo](https://axmo.it/ai/recipes/walkthrough-demo.model.yaml)

## Samples

- [Sample workbook](https://axmo.it/ai/samples/walkthrough.xlsx): an Axmo workbook to try the workbook tool on; what extract gives for it is under samples/

## Optional

- [Tool contract](https://axmo.it/ai/generated/tool-contract.md)
- [Third-party notices](https://axmo.it/ai/tool/THIRD-PARTY-LICENSES.txt)