FABLE Pyculator

Guides

  • Reference Artifacts
    • VSCode Environment Bootstrap
  • FABLE-C Workbook Structure
    • High-Level Structure
    • Scenario Selection Controls
    • Initial Headline Outputs
    • Cross-Version Notes
    • Scenario Definition Tables
    • Output Column Flavour Tags
    • Package Mapping
  • Notebook Control Surface
    • Minimal Example
    • 2020 Notebook Loop
    • 2021 Notebook Loop
    • Scenario Bundles
    • Scenario-Definition Patches
    • 2021 FreshForge Build Plan
    • 2021 FreshForge Run Companion
    • Current Scope
  • Editable Scenario-Definition Patches
    • Editable Scope
    • Patch Schema
    • Hands-On Notebook
    • Validate A Patch
    • Use In Notebook Loops
    • Current Boundary
  • Scenario Bundles
    • Bundle Format
    • Run From Python
    • Run From The Script
    • Render Overrides
    • FreshForge Orchestration
  • FreshForge Scenario-Bundle Orchestration
    • Plan A Workflow
    • Run With A Namespace
    • Plan A Matrix
    • Run A Matrix
    • Python API
    • Boundary
  • 2020 Notebook Workflow
    • Local Artifacts
    • Build The Spec
    • Choose Scenario Values
    • Run The Model
    • Read Outputs
    • Current Boundary
  • Generated Model Artifacts
    • Local Artifact Contract
    • Spec Discovery Versus Model Generation
    • About Modelwright JSON Inputs
    • Current Validation Boundary
    • Compact Evidence Summaries
  • FreshForge Provider Integration
    • Installation Boundary
    • Provider Nodes
    • Example
    • Boundary
  • Output-Ref Strategy Comparison
    • Why Compare Strategies?
    • Run A Comparison
    • FreshForge Matrix
    • FreshForge Namespaces
    • Evidence Summaries
    • Claim Boundary
  • FABLE FreshForge Rebuild Command
    • Plan-Only Preparation
    • Explicit FreshForge Run
    • Output-Ref Options
    • Boundary
  • Validation Evidence Packaging
    • Package Local Evidence
    • Opt-In Benchmark Orchestration
    • Evidence Status
    • Manual Workflow
    • Claim Boundary
  • Opt-In Benchmark Evidence Workflow
    • Modes
    • Examples
    • Evidence Backend
    • Manual GitHub Workflow
    • Scenario-Bundle Context
    • Matrix Evidence
  • FABLE 2021 Benchmark Matrix Evidence Cookbook
    • 1. Compare Strategy Boundaries
    • 2. Write And Plan The Matrix
    • 3. Optional Explicit Matrix Run
    • 4. Package Matrix Evidence
    • Backend Requirement
    • Claim Boundary
  • Validation Scope
    • What Is Validated Here
    • Compact Evidence Packaging
    • Modelwright 2020 Benchmark Evidence
    • FABLE Pyculator 2021 Evidence
    • Claim Boundary
  • Release And Deployment
    • Current Alpha Target
    • Local Release Checks
    • Documentation Deployment Gate
    • TestPyPI Rehearsal
    • Real PyPI Publication
    • Rollback And Yanking
    • Private Data Rules

API

  • API Reference
    • Package Facade
    • Typed Specifications
      • FableCalculatorSpec
      • HeadlinePoint
      • HeadlineSeries
      • OutputIndicator
      • OutputTable
      • ScenarioDefinitionTable
      • ScenarioParameter
      • SelectionControl
      • SelectionOption
    • Workbook Discovery
      • curate_default_headline_series()
      • discover_output_tables()
      • discover_scenario_definition_tables()
      • discover_scenario_parameters()
      • discover_selection_controls()
    • Workbook Loading
      • load_fable_workbook()
      • suppress_benign_openpyxl_warnings()
    • Notebook Controls
      • ScenarioControlSurface
    • Notebook Loop
      • NotebookLoopResult
      • build_2020_notebook_spec()
      • build_2021_notebook_spec()
      • build_notebook_spec()
      • load_generated_model()
      • run_2020_notebook_loop()
      • run_2021_notebook_loop()
      • run_notebook_loop()
    • Rendering And Execution
      • ScenarioRun
      • headline_frame()
      • headline_frames()
      • output_table_frame()
      • output_tables()
      • outputs_frame()
      • plot_headline()
      • plot_outputs()
      • run_scenario()
      • scenario_definition_table_frame()
      • scenario_definition_tables()
      • scenario_definition_tables_for_location()
      • scenario_frame()
    • Scenario-Definition Patches
      • ScenarioDefinitionEdit
      • ScenarioDefinitionEditableCell
      • ScenarioDefinitionPatch
      • ScenarioDefinitionPatchResult
      • editable_scenario_definition_cells()
      • load_scenario_definition_patch()
      • scenario_definition_input_mapping()
      • validate_scenario_definition_patch()
      • write_scenario_definition_patch()
    • Scenario Bundles
      • ScenarioBundle
      • ScenarioBundleArtifactPaths
      • ScenarioBundleRenderOptions
      • ScenarioBundleRunResult
      • ScenarioCase
      • fable_scenario_bundle_artifact_paths()
      • load_scenario_bundle()
      • run_scenario_bundle()
      • validate_scenario_bundle()
      • write_scenario_artifacts()
      • write_scenario_bundle_artifacts()
    • Scenario-Bundle FreshForge Workflows
      • ScenarioBundleFreshForgeMatrixPaths
      • ScenarioBundleFreshForgeMatrixPlan
      • ScenarioBundleFreshForgePaths
      • ScenarioBundleFreshForgePlan
      • build_scenario_bundle_freshforge_matrix()
      • build_scenario_bundle_freshforge_matrix_template()
      • build_scenario_bundle_freshforge_workflow()
      • default_generated_model_path()
      • fable_scenario_bundle_freshforge_matrix_paths()
      • fable_scenario_bundle_freshforge_paths()
      • plan_scenario_bundle_freshforge_matrix()
      • prepare_scenario_bundle_freshforge_matrix()
      • prepare_scenario_bundle_freshforge_workflow()
      • run_scenario_bundle_freshforge_matrix()
      • run_scenario_bundle_freshforge_workflow()
      • write_scenario_bundle_freshforge_matrix_summary()
      • write_scenario_bundle_freshforge_summary()
    • Benchmark Evidence
      • FableBenchmarkMatrixEvidencePaths
      • FableBenchmarkMatrixEvidenceSummary
      • FableBenchmarkRunPaths
      • FableBenchmarkRunSummary
      • fable_benchmark_matrix_evidence_paths()
      • fable_benchmark_run_paths()
      • package_fable_benchmark_evidence()
      • package_fable_benchmark_matrix_evidence()
      • write_fable_benchmark_matrix_evidence()
      • write_fable_benchmark_summary()
    • Validation Evidence
      • ValidationEvidencePaths
      • ValidationEvidenceSummary
      • extract_validation_evidence()
      • fable_validation_evidence_paths()
      • write_validation_evidence()
    • Output-Ref Strategy Comparison
      • OutputRefStrategyCase
      • OutputRefStrategyComparisonEntry
      • OutputRefStrategyComparisonPaths
      • OutputRefStrategyComparisonResult
      • OutputRefStrategyMatrixPaths
      • OutputRefStrategyMatrixResult
      • build_output_ref_strategy_matrix()
      • compare_output_ref_strategies()
      • default_output_ref_strategy_cases()
      • output_ref_strategy_comparison_paths()
      • plan_output_ref_strategy_matrix()
      • run_output_ref_strategy_matrix()
      • write_output_ref_strategy_comparison()
      • write_output_ref_strategy_matrix()
    • FreshForge Workflow Helpers
      • FableFreshForgeBuildPaths
      • FableFreshForgeRebuildPlan
      • build_cached_workbook_validation_scenario()
      • build_modelwright_freshforge_workflow()
      • derive_output_refs()
      • derive_output_refs_for_strategy()
      • fable_freshforge_build_paths()
      • freshforge_2021_build_paths()
      • prepare_2021_freshforge_rebuild()
      • prepare_freshforge_rebuild()
      • write_freshforge_workflow()
      • write_output_refs()
      • write_validation_scenario()
    • FreshForge Provider
      • FablePyculatorFreshForgeProvider
      • provider_factory()
FABLE Pyculator
  • Overview: module code

All modules for which code is available

  • fable_pyculator.benchmarks
  • fable_pyculator.controls
  • fable_pyculator.discovery
  • fable_pyculator.freshforge
  • fable_pyculator.notebook
  • fable_pyculator.scenario_definitions
  • fable_pyculator.scenario_workflows
  • fable_pyculator.scenarios
  • fable_pyculator.spec
  • fable_pyculator.strategy_comparison
  • fable_pyculator.surface
  • fable_pyculator.validation
  • fable_pyculator.workbook
  • fable_pyculator.workflows

© Copyright 2026, UBC FRESH Lab.

Built with Sphinx using a theme provided by Read the Docs.