---
format: allocait.setup-file
version: 1
id: starter-example
revision: 1
name: Starter example
author: Example Author
description: One scenario with ranges for three classes, one watchlist, two Inputs and a playbook that lists both for every symbol on the watchlist. Every name and number is made up.
disclosure: Illustrative example. The figures are hypothetical, not a recommendation. Every name and number in this file is made up.
scenarios:
  - name: Starter rules
    description: A range for each of three classes. Replace each with your own.
    classes:
      Equities: { min: 0, max: 73, position_size: { min: 3, max: 9 } }
      Fixed Income: { min: 0, max: 41 }
      Cash: { min: 7, max: 100 }
watchlists:
  - name: Main list
    items:
      - { symbol: ALFA, asset_class: Equities }
      - { symbol: BRAV, asset_class: Equities }
      - { symbol: CHAR, asset_class: Fixed Income }
inputs:
  - name: Low end
    data_type: DECIMAL
    scope: SYMBOL
    description: Low end of today's range for the symbol. Type it each morning.
  - name: High end
    data_type: DECIMAL
    scope: SYMBOL
    description: Top end of today's range for the symbol. Type it each morning.
portfolio:
  playbooks:
    - name: Morning levels
      description: Both ends of today's range for each symbol on the main list.
      source: watchlist
      watchlist: Main list
      inputs: [Low end, High end]
---

# Starter example

By Example Author.

A small setup file to copy: one scenario, one watchlist, two Inputs and one playbook. Replace each name and number with your own, and leave out any key you do not need.