EnergyAE / Knowledge Base

File Structure

The project folder layout for a residential HPWH modelling job, mapped to the modelling pipeline.

A residential modelling job uses four top-level folders. They map directly onto the /model-res pipeline: 02-Client_Material is the pipeline Input, 03-Modelling holds the .pipeline working state, and 04-Submission is the pipeline Output.

AE###_BRAND/
├── 01-Admin/                   
│   ├── PURCHASE_ORDER.pdf      Purchase order, signed engagement
├── 02-Client_Material/         (pipeline "Input")
│   ├── BRAND_MODEL1/           per-model documents:
│   │     BRAND_MODEL1_5125.pdf
│   │     BRAND_MODEL1_4692.pdf
│   │     BRAND_MODEL1_Dimension.pdf
│   │     BRAND_MODEL1_PipeInsulation.pdf    (standalone only)
│   │     BRAND_MODEL1_Manual.pdf
│   │     BRAND_MODEL1_Dataplate.png         (integral)
│   │       — or —
│   │     BRAND_MODEL1_HP_Dataplate.png      (standalone)
│   │     BRAND_MODEL1_Tank_Dataplate.png    (standalone)
│   │     BRAND_MODEL1_Schematic.pdf         (standalone only)
│   │     BRAND_MODEL1_2712.pdf
│   │     BRAND_MODEL1_ElectricalSafety.pdf
│   │     BRAND_MODEL1_Control.docx
│   │     BRAND_MODEL1_Warranty.pdf
│   │     BRAND_MODEL1_TC2.xlsx              (integral only)
│   │     BRAND_MODEL1_TC5.xlsx
│   ├── BRAND_MODEL2/           second model, same layout
│   └── BRAND_shared_*.*        docs common to all models, filed loose
│                               (e.g. shared HP _5125, _Manual, _Dataplate, _TC5)
├── 03-Modelling/               .pipeline working state per model:
│                                 jobspec.json, extraction.json, calibration.json,
│                                 grid_results.json, <BRAND_MODEL>_workings.md
└── 04-Submission/              (pipeline "Output")
    ├── SRES/                   CER: <Manufacturer>/<BRAND_MODEL>/
    │                             Test_Reports/, Technical_Details/, TRNSYS_Files/
    │                             + <BRAND>_PartC.xlsx (one per company)
    ├── VEU_1D3C/               per-model pack + <BRAND_MODEL>_VEU_upload.xlsx
    └── ESS_D17D19/             per-model pack + <BRAND_MODEL>_ESS_upload.xlsx

Worked example — standalone, multi-model (AE664_CHOFU)

Four tank models on one heat pump. The shared HP docs sit loose at the Input/ root; each model folder holds only its unique _4692 and _Dimension. Standalone, so the SRES deck set has no DTHX (frosting only).

AE664_CHOFU/
├── Input/                              (→ 02-Client_Material)
│   ├── CHOFU_5125.pdf                  shared HP docs, loose at root
│   ├── CHOFU_2712.pdf
│   ├── CHOFU_Manual.pdf
│   ├── CHOFU_Dataplate.png
│   ├── CHOFU_Schematic.png
│   ├── CHOFU_ElectricalSafety.pdf      (legacy projects: _EESS)
│   ├── CHOFU_Control.pdf
│   ├── CHOFU_TC2.xlsx   CHOFU_TC5.xlsx
│   ├── CHOFU_THPEC45x160/              per-model: only the unique tank docs
│   │     CHOFU_THPEC45x160_4692.pdf
│   │     CHOFU_THPEC45x160_Dimension.pdf
│   ├── CHOFU_THPEC45x250/   …_4692.pdf   …_Dimension.pdf
│   ├── CHOFU_THPEC45x315/   …
│   └── CHOFU_THPEC45x400/   …
├── .pipeline/                          (→ 03-Modelling) one folder per model
│   ├── CHOFU_THPEC45x160/
│   │     jobspec.json  extraction.json  extract_5125.json
│   │     calibration.json  grid_results.json  generated.json
│   │     CHOFU_THPEC45x160_workings.md
│   │     generated/                    editable docx/xlsx before packing
│   │       CHOFU_THPEC45x160_4234.docx    CHOFU_THPEC45x160_4234.pdf
│   │       CHOFU_THPEC45x160_control.docx CHOFU_THPEC45x160_control.pdf
│   │       CHOFU_THPEC45x160_TDS.xlsx     CHOFU_THPEC45x160_PartC.xlsx
│   │       CHOFU_THPEC45x160_VEU_upload.xlsx
│   │       CHOFU_THPEC45x160_ESS_upload.xlsx
│   ├── CHOFU_THPEC45x250/   …
│   ├── CHOFU_THPEC45x315/   …
│   └── CHOFU_THPEC45x400/   …
└── Output/                             (→ 04-Submission) the audit packs
    ├── SRES/
    │   └── Reece Australia Pty Ltd/        manufacturer legal name
    │       ├── CHOFU_PartC.xlsx            ONE per company
    │       └── CHOFU_THPEC45x160/          (one folder per model)
    │             Test_Reports/      _2712.pdf _4234.pdf _4692.pdf _5125.pdf
    │             Technical_Details/ _TDS.xlsx _dimension.pdf _manual.pdf
    │             TRNSYS_Files/      _Z1 … _Z5  +  FP/        (no DTHX)
    ├── VEU_1D3C/
    │   ├── CHOFU_THPEC45x160/
    │   │     _2712.pdf _4234.pdf _4692.pdf _5125.pdf _ElectricalSafety.pdf
    │   │     _TDS.xlsx _control.pdf _dataplate_HP.png _dimension.pdf _manual.pdf
    │   │     TRNSYS_Files/   FP/   L1/(Z4,Z5)   L2/(Z3,Z4,Z5)
    │   ├── CHOFU_THPEC45x160_VEU_upload.xlsx
    │   └── CHOFU_THPEC45x250/  …                (repeats per model)
    └── ESS_D17D19/
        ├── CHOFU_THPEC45x160/                   same docs as VEU
        │     TRNSYS_Files/   FP/   L2/(Z3,Z4,Z5)
        └── CHOFU_THPEC45x160_ESS_upload.xlsx

Worked example — integral, single model (AE600_ARISTON)

One model, self-contained. Integral, so _TC2 is present (DTHX calibration) and the SRES deck set includes DTHX. A single-model job keeps .pipeline state flat (no per-model subfolder).

AE600_ARISTON/
├── Input/                              (→ 02-Client_Material)
│   └── ARISTON_ARIHPWH-320/
│         ARISTON_ARIHPWH-320_5125.pdf  _4692.pdf  _Dimension.pdf  _Manual.pdf
│         ARISTON_ARIHPWH-320_Dataplate.png        single plate (integral)
│         ARISTON_ARIHPWH-320_2712.pdf  _ElectricalSafety.pdf  _Warranty.pdf
│         ARISTON_ARIHPWH-320_TC2.xlsx  _TC5.xlsx  (TC2 = DTHX calibration)
├── .pipeline/                          (→ 03-Modelling) flat for a single model
│     jobspec.json  extraction.json  extract_5125.json  calibration.json
│     grid_results.json  generated.json
│     ARISTON_ARIHPWH-320_workings.md
└── Output/                             (→ 04-Submission)
    ├── SRES/
    │   └── Ariston S.p.A/
    │       ├── ARISTON_PartC.xlsx
    │       └── ARISTON_ARIHPWH-320/
    │             Test_Reports/      _2712.pdf _4234.pdf _4692.pdf _5125.pdf
    │             Technical_Details/ _TDS.xlsx _dimension.pdf _manual.pdf
    │             TRNSYS_Files/      _Z1 … _Z5  +  DTHX/  +  FP/    (DTHX present)
    ├── VEU_1D3C/
    │   ├── ARISTON_ARIHPWH-320/
    │   │     _2712.pdf _4234.pdf _4692.pdf _5125.pdf _ElectricalSafety.pdf
    │   │     _TDS.xlsx _control.pdf _dataplate_HP.png _dimension.pdf _manual.pdf
    │   │     TRNSYS_Files/   FP/   L1/(Z4,Z5)   L2/(Z3,Z4,Z5)
    │   └── ARISTON_ARIHPWH-320_VEU_upload.xlsx
    └── ESS_D17D19/
        ├── ARISTON_ARIHPWH-320/
        │     TRNSYS_Files/   FP/   L2/(Z3,Z4,Z5)
        └── ARISTON_ARIHPWH-320_ESS_upload.xlsx

Notes

  • Model folders are named BRAND_MODEL (uppercase BRAND, underscore join, hyphens in the model name preserved, e.g. ARISTON_ARIHPWH-320). The .pipeline state folder name matches the model folder.
  • Shared docs at the root of 02-Client_Material are auto-merged into each model at extraction time; a doc in the model folder wins over the shared copy on a name collision.
  • Audit-pack contents differ by scheme - see the scheme-evidence reminder in Document Review. SRES splits docs into Test_Reports/ + Technical_Details/ under the manufacturer legal name and omits the control declaration, dataplate, and electrical safety certificate; VEU and ESS keep docs flat in the model folder and include them.
  • TRNSYS deck sets differ by system type and scheme: integral packs include a DTHX/ folder, standalone packs do not (frosting FP/ only). SRES ships all five zones flat (_Z1…_Z5), VEU ships L1/ (zones 4–5) + L2/ (zones 3–5), ESS ships L2/ only.
  • The 4234 report and control declaration ship as PDF (the editable .docx stays in .pipeline/<model>/generated/); legacy projects may show electrical-safety input files named _EESS rather than _ElectricalSafety.
  • The live AE999_Res_HP_Modelling template currently ships only the four-folder skeleton plus the Gate A and Gate B workbooks. The Input/Output detail above is populated per project by the /model-res pipeline.
← Previous Document Review
Next → 4. Modelling