Class SeedMeta

Implements

Constructors

constructor

Properties

activity arch compressed condition f280? fuelCosts? h2kMaker_version project projectName? revisioned revisioned_output run? seed_version swaps token units wizard?

Constructors

constructor

Properties

activity

activity: "retro" | "build" = 'retro'

arch

arch: "SFD" | "MURB" = 'SFD'

Will be deprecated Please use seed.house.space.arch instead.

compressed

compressed: (
    | "length"
    | "type"
    | "entity"
    | "height"
    | "direction"
    | "adjacent"
    | "room"
    | "storey"
    | "perimeter"
    | "area"
    | "corners"
    | "intersections"
    | "windows"
    | "doors"
    | "header"
    | "slope"
    | "wall_entity"
    | "inside_entity"
    | "outside_entity"
    | "slab_entity"
    | "floorsAbove_entity"
    | "exterior_perimeter"
    | "above_grade_wall_area"
    | "below_grade_wall_area"
    | "depth"
    | "heated_slab"
    | "integral_footing"
    | "ponyWall"
    | "feature_entity"
    | "usage"
)[] = []

condition

condition: "before" | "after" = 'before'

Defines if the current seed represents pre or post upgrade condition. Used to filter out entities that are not the same condition.

'before' should contain only one option for equipment, while 'after' can contain many options.

Optionalf280

f280?: { achMode?: AchMode }

Optional inputs for F280 report output

OptionalfuelCosts

fuelCosts?: {
    Electricity: {
        baseCost?: number;
        cost: { limit: number; price: number }[];
    };
    Gas: { baseCost?: number; cost: { limit: number; price: number }[] };
}

Optional custom pricing for fuel. Price is in dollars per kWh

Any provided costs will overwrite the default pricing. Default costs will be used for any fuel type not provided.

Base cost is optional, represents a base monthly amount that is charged regardless of energy usage.

The cost array lets you specify tiered pricing where the cost changes based on the amount of energy used.

If you just want to have a single price, you can just give a single cost with the limit set to 0. For tiered pricing, you specify the limit as the amount of energy usage in kWh before the next tier of price kicks in.

h2kMaker_version

h2kMaker_version: string = '15.2.0'

project

project: SeedProject = ...

Contains information about the project address. This will be automatically filled with the createSeedFromAddress endpoint.

OptionalprojectName

projectName?: string

Optional name of the project. This will be shown in the reports.

revisioned

revisioned: (
    | "house.walls.entity"
    | "house.walls.height"
    | "house.walls.direction"
    | "house.walls.adjacent"
    | "house.walls.room"
    | "house.walls.storey"
    | "house.walls.perimeter"
    | "house.walls.area"
    | "house.walls.corners"
    | "house.walls.intersections"
    | "house.walls.windows.type"
    | "house.walls.windows.entity"
    | "house.walls.windows.shgc_entity"
    | "house.walls.windows.assembled_entity"
    | "house.walls.windows.height"
    | "house.walls.windows.width"
    | "house.walls.windows.direction"
    | "house.walls.windows.overhang_width"
    | "house.walls.windows.overhang_height"
    | "house.walls.windows.tilt"
    | "house.walls.windows.adjacent"
    | "house.walls.windows.blinds"
    | "house.walls.doors.type"
    | "house.walls.doors.entity"
    | "house.walls.doors.height"
    | "house.walls.doors.width"
    | "house.walls.doors.direction"
    | "house.walls.doors.adjacent"
    | "house.walls.header.entity"
    | "house.walls.header.height"
    | "house.walls.header.adjacent"
    | "house.walls.header.perimeter"
    | "house.attics.length"
    | "house.attics.type"
    | "house.attics.entity"
    | "house.attics.room"
    | "house.attics.area"
    | "house.attics.slope"
    | "house.attics.windows.type"
    | "house.attics.windows.entity"
    | "house.attics.windows.shgc_entity"
    | "house.attics.windows.assembled_entity"
    | "house.attics.windows.height"
    | "house.attics.windows.width"
    | "house.attics.windows.direction"
    | "house.attics.windows.overhang_width"
    | "house.attics.windows.overhang_height"
    | "house.attics.windows.tilt"
    | "house.attics.windows.adjacent"
    | "house.attics.windows.blinds"
    | "house.decks.length"
    | "house.decks.entity"
    | "house.decks.room"
    | "house.decks.area"
    | "house.decks.windows.type"
    | "house.decks.windows.entity"
    | "house.decks.windows.shgc_entity"
    | "house.decks.windows.assembled_entity"
    | "house.decks.windows.height"
    | "house.decks.windows.width"
    | "house.decks.windows.direction"
    | "house.decks.windows.overhang_width"
    | "house.decks.windows.overhang_height"
    | "house.decks.windows.tilt"
    | "house.decks.windows.adjacent"
    | "house.decks.windows.blinds"
    | "house.cathedrals.length"
    | "house.cathedrals.entity"
    | "house.cathedrals.room"
    | "house.cathedrals.area"
    | "house.cathedrals.slope"
    | "house.cathedrals.windows.type"
    | "house.cathedrals.windows.entity"
    | "house.cathedrals.windows.shgc_entity"
    | "house.cathedrals.windows.assembled_entity"
    | "house.cathedrals.windows.height"
    | "house.cathedrals.windows.width"
    | "house.cathedrals.windows.direction"
    | "house.cathedrals.windows.overhang_width"
    | "house.cathedrals.windows.overhang_height"
    | "house.cathedrals.windows.tilt"
    | "house.cathedrals.windows.adjacent"
    | "house.cathedrals.windows.blinds"
    | "house.equipment.pv.entity"
    | "house.equipment.aux.entity"
    | "house.equipment.dhw.entity"
    | "house.equipment.dhw.dhw2_entity"
    | "house.equipment.hrv.entity"
    | "house.equipment.mech.entity"
    | "house.equipment.suppl.entity"
    | "house.equipment.ventilation.mechanical_supply_rate_ls"
    | "house.equipment.ventilation.fans.type"
    | "house.equipment.ventilation.fans.room"
    | "house.equipment.ventilation.fans.whole_house"
    | "house.equipment.ventilation.fans.supply_ls"
    | "house.equipment.ventilation.fans.exhaust_ls"
    | "house.equipment.ventilation.fans.daily_usage_hours"
    | "house.equipment.ventilation.fans.auto_power"
    | "house.equipment.ventilation.fans.comment"
    | "house.equipment.bundle.entity"
    | "house.basements.height"
    | "house.basements.adjacent"
    | "house.basements.room"
    | "house.basements.perimeter"
    | "house.basements.area"
    | "house.basements.corners"
    | "house.basements.wall_entity"
    | "house.basements.inside_entity"
    | "house.basements.outside_entity"
    | "house.basements.slab_entity"
    | "house.basements.floorsAbove_entity"
    | "house.basements.exterior_perimeter"
    | "house.basements.above_grade_wall_area"
    | "house.basements.below_grade_wall_area"
    | "house.basements.depth"
    | "house.basements.heated_slab"
    | "house.basements.integral_footing"
    | "house.basements.windows.type"
    | "house.basements.windows.entity"
    | "house.basements.windows.shgc_entity"
    | "house.basements.windows.assembled_entity"
    | "house.basements.windows.height"
    | "house.basements.windows.width"
    | "house.basements.windows.direction"
    | "house.basements.windows.overhang_width"
    | "house.basements.windows.overhang_height"
    | "house.basements.windows.tilt"
    | "house.basements.windows.adjacent"
    | "house.basements.windows.blinds"
    | "house.basements.doors.type"
    | "house.basements.doors.entity"
    | "house.basements.doors.height"
    | "house.basements.doors.width"
    | "house.basements.doors.direction"
    | "house.basements.doors.adjacent"
    | "house.basements.header.entity"
    | "house.basements.header.height"
    | "house.basements.header.adjacent"
    | "house.basements.header.perimeter"
    | "house.basements.ponyWall.entity"
    | "house.basements.ponyWall.height"
    | "house.basements.ponyWall.perimeter"
    | "house.crawlSpaces.height"
    | "house.crawlSpaces.adjacent"
    | "house.crawlSpaces.room"
    | "house.crawlSpaces.perimeter"
    | "house.crawlSpaces.area"
    | "house.crawlSpaces.corners"
    | "house.crawlSpaces.wall_entity"
    | "house.crawlSpaces.slab_entity"
    | "house.crawlSpaces.floorsAbove_entity"
    | "house.crawlSpaces.exterior_perimeter"
    | "house.crawlSpaces.above_grade_wall_area"
    | "house.crawlSpaces.below_grade_wall_area"
    | "house.crawlSpaces.depth"
    | "house.crawlSpaces.heated_slab"
    | "house.crawlSpaces.integral_footing"
    | "house.crawlSpaces.feature_entity"
    | "house.crawlSpaces.usage"
    | "house.crawlSpaces.header.entity"
    | "house.crawlSpaces.header.height"
    | "house.crawlSpaces.header.adjacent"
    | "house.crawlSpaces.header.perimeter"
    | "house.SOGs.entity"
    | "house.SOGs.room"
    | "house.SOGs.perimeter"
    | "house.SOGs.area"
    | "house.SOGs.exterior_perimeter"
    | "house.SOGs.heated_slab"
    | "house.SOGs.integral_footing"
    | "house.SOGs.feature_entity"
    | "house.exposedFloors.length"
    | "house.exposedFloors.entity"
    | "house.exposedFloors.adjacent"
    | "house.exposedFloors.room"
    | "house.exposedFloors.area"
    | "house.space.ach"
    | "house.space.baseline_ach"
    | "house.space.year"
    | "house.space.shape"
    | "house.space.total_heated_area"
    | "house.space.total_heated_volume"
    | "house.space.operation"
    | "house.space.heading"
    | "house.space.rooms.name"
    | "house.space.rooms.type"
    | "house.space.rooms.storey"
    | "house.space.rooms.heated_area_m2"
    | "house.space.rooms.heated_volume_m3"
    | "house.space.rooms.occupants"
    | "house.space.rooms.internal_gain_fraction"
    | "house.space.rooms.air_supply_ls"
    | "house.space.rooms.air_exhaust_ls"
    | "house.space.rooms.ducting.entity"
    | "house.space.rooms.ducting.through"
    | "house.space.rooms.piping.entity"
    | "meta.f280"
    | "meta.units"
    | "meta.compressed"
    | "meta.projectName"
    | "meta.user"
    | "meta.arch"
    | "meta.condition"
    | "meta.activity"
    | "meta.fuelCosts"
    | "meta.token"
    | "meta.action"
    | "meta.wizard"
    | "meta.run"
    | `meta.swaps.${string}`
    | "meta.project.name"
    | "meta.project.fileId"
    | "meta.project.taxRollNumber"
    | "meta.project.evaluationDate"
    | "meta.project.address"
    | "meta.project.city"
    | "meta.project.country"
    | "meta.project.countryCode"
    | "meta.project.administrative"
    | "meta.project.district"
    | "meta.project.postcode"
    | "meta.project.value"
    | "meta.project.place_id"
    | "meta.project.base_address"
    | "meta.project.latlng.lat"
    | "meta.project.latlng.lng"
)[] = ...

saves revisions for Activity build

revisioned_output

revisioned_output: (
    | "house.walls.entity"
    | "house.walls.height"
    | "house.walls.direction"
    | "house.walls.adjacent"
    | "house.walls.room"
    | "house.walls.storey"
    | "house.walls.perimeter"
    | "house.walls.area"
    | "house.walls.corners"
    | "house.walls.intersections"
    | "house.walls.windows.type"
    | "house.walls.windows.entity"
    | "house.walls.windows.shgc_entity"
    | "house.walls.windows.assembled_entity"
    | "house.walls.windows.height"
    | "house.walls.windows.width"
    | "house.walls.windows.direction"
    | "house.walls.windows.overhang_width"
    | "house.walls.windows.overhang_height"
    | "house.walls.windows.tilt"
    | "house.walls.windows.adjacent"
    | "house.walls.windows.blinds"
    | "house.walls.doors.type"
    | "house.walls.doors.entity"
    | "house.walls.doors.height"
    | "house.walls.doors.width"
    | "house.walls.doors.direction"
    | "house.walls.doors.adjacent"
    | "house.walls.header.entity"
    | "house.walls.header.height"
    | "house.walls.header.adjacent"
    | "house.walls.header.perimeter"
    | "house.attics.length"
    | "house.attics.type"
    | "house.attics.entity"
    | "house.attics.room"
    | "house.attics.area"
    | "house.attics.slope"
    | "house.attics.windows.type"
    | "house.attics.windows.entity"
    | "house.attics.windows.shgc_entity"
    | "house.attics.windows.assembled_entity"
    | "house.attics.windows.height"
    | "house.attics.windows.width"
    | "house.attics.windows.direction"
    | "house.attics.windows.overhang_width"
    | "house.attics.windows.overhang_height"
    | "house.attics.windows.tilt"
    | "house.attics.windows.adjacent"
    | "house.attics.windows.blinds"
    | "house.decks.length"
    | "house.decks.entity"
    | "house.decks.room"
    | "house.decks.area"
    | "house.decks.windows.type"
    | "house.decks.windows.entity"
    | "house.decks.windows.shgc_entity"
    | "house.decks.windows.assembled_entity"
    | "house.decks.windows.height"
    | "house.decks.windows.width"
    | "house.decks.windows.direction"
    | "house.decks.windows.overhang_width"
    | "house.decks.windows.overhang_height"
    | "house.decks.windows.tilt"
    | "house.decks.windows.adjacent"
    | "house.decks.windows.blinds"
    | "house.cathedrals.length"
    | "house.cathedrals.entity"
    | "house.cathedrals.room"
    | "house.cathedrals.area"
    | "house.cathedrals.slope"
    | "house.cathedrals.windows.type"
    | "house.cathedrals.windows.entity"
    | "house.cathedrals.windows.shgc_entity"
    | "house.cathedrals.windows.assembled_entity"
    | "house.cathedrals.windows.height"
    | "house.cathedrals.windows.width"
    | "house.cathedrals.windows.direction"
    | "house.cathedrals.windows.overhang_width"
    | "house.cathedrals.windows.overhang_height"
    | "house.cathedrals.windows.tilt"
    | "house.cathedrals.windows.adjacent"
    | "house.cathedrals.windows.blinds"
    | "house.equipment.pv.entity"
    | "house.equipment.aux.entity"
    | "house.equipment.dhw.entity"
    | "house.equipment.dhw.dhw2_entity"
    | "house.equipment.hrv.entity"
    | "house.equipment.mech.entity"
    | "house.equipment.suppl.entity"
    | "house.equipment.ventilation.mechanical_supply_rate_ls"
    | "house.equipment.ventilation.fans.type"
    | "house.equipment.ventilation.fans.room"
    | "house.equipment.ventilation.fans.whole_house"
    | "house.equipment.ventilation.fans.supply_ls"
    | "house.equipment.ventilation.fans.exhaust_ls"
    | "house.equipment.ventilation.fans.daily_usage_hours"
    | "house.equipment.ventilation.fans.auto_power"
    | "house.equipment.ventilation.fans.comment"
    | "house.equipment.bundle.entity"
    | "house.basements.height"
    | "house.basements.adjacent"
    | "house.basements.room"
    | "house.basements.perimeter"
    | "house.basements.area"
    | "house.basements.corners"
    | "house.basements.wall_entity"
    | "house.basements.inside_entity"
    | "house.basements.outside_entity"
    | "house.basements.slab_entity"
    | "house.basements.floorsAbove_entity"
    | "house.basements.exterior_perimeter"
    | "house.basements.above_grade_wall_area"
    | "house.basements.below_grade_wall_area"
    | "house.basements.depth"
    | "house.basements.heated_slab"
    | "house.basements.integral_footing"
    | "house.basements.windows.type"
    | "house.basements.windows.entity"
    | "house.basements.windows.shgc_entity"
    | "house.basements.windows.assembled_entity"
    | "house.basements.windows.height"
    | "house.basements.windows.width"
    | "house.basements.windows.direction"
    | "house.basements.windows.overhang_width"
    | "house.basements.windows.overhang_height"
    | "house.basements.windows.tilt"
    | "house.basements.windows.adjacent"
    | "house.basements.windows.blinds"
    | "house.basements.doors.type"
    | "house.basements.doors.entity"
    | "house.basements.doors.height"
    | "house.basements.doors.width"
    | "house.basements.doors.direction"
    | "house.basements.doors.adjacent"
    | "house.basements.header.entity"
    | "house.basements.header.height"
    | "house.basements.header.adjacent"
    | "house.basements.header.perimeter"
    | "house.basements.ponyWall.entity"
    | "house.basements.ponyWall.height"
    | "house.basements.ponyWall.perimeter"
    | "house.crawlSpaces.height"
    | "house.crawlSpaces.adjacent"
    | "house.crawlSpaces.room"
    | "house.crawlSpaces.perimeter"
    | "house.crawlSpaces.area"
    | "house.crawlSpaces.corners"
    | "house.crawlSpaces.wall_entity"
    | "house.crawlSpaces.slab_entity"
    | "house.crawlSpaces.floorsAbove_entity"
    | "house.crawlSpaces.exterior_perimeter"
    | "house.crawlSpaces.above_grade_wall_area"
    | "house.crawlSpaces.below_grade_wall_area"
    | "house.crawlSpaces.depth"
    | "house.crawlSpaces.heated_slab"
    | "house.crawlSpaces.integral_footing"
    | "house.crawlSpaces.feature_entity"
    | "house.crawlSpaces.usage"
    | "house.crawlSpaces.header.entity"
    | "house.crawlSpaces.header.height"
    | "house.crawlSpaces.header.adjacent"
    | "house.crawlSpaces.header.perimeter"
    | "house.SOGs.entity"
    | "house.SOGs.room"
    | "house.SOGs.perimeter"
    | "house.SOGs.area"
    | "house.SOGs.exterior_perimeter"
    | "house.SOGs.heated_slab"
    | "house.SOGs.integral_footing"
    | "house.SOGs.feature_entity"
    | "house.exposedFloors.length"
    | "house.exposedFloors.entity"
    | "house.exposedFloors.adjacent"
    | "house.exposedFloors.room"
    | "house.exposedFloors.area"
    | "house.space.ach"
    | "house.space.baseline_ach"
    | "house.space.year"
    | "house.space.shape"
    | "house.space.total_heated_area"
    | "house.space.total_heated_volume"
    | "house.space.operation"
    | "house.space.heading"
    | "house.space.rooms.name"
    | "house.space.rooms.type"
    | "house.space.rooms.storey"
    | "house.space.rooms.heated_area_m2"
    | "house.space.rooms.heated_volume_m3"
    | "house.space.rooms.occupants"
    | "house.space.rooms.internal_gain_fraction"
    | "house.space.rooms.air_supply_ls"
    | "house.space.rooms.air_exhaust_ls"
    | "house.space.rooms.ducting.entity"
    | "house.space.rooms.ducting.through"
    | "house.space.rooms.piping.entity"
    | "meta.f280"
    | "meta.units"
    | "meta.compressed"
    | "meta.projectName"
    | "meta.user"
    | "meta.arch"
    | "meta.condition"
    | "meta.activity"
    | "meta.fuelCosts"
    | "meta.token"
    | "meta.action"
    | "meta.wizard"
    | "meta.run"
    | `meta.swaps.${string}`
    | "meta.project.name"
    | "meta.project.fileId"
    | "meta.project.taxRollNumber"
    | "meta.project.evaluationDate"
    | "meta.project.address"
    | "meta.project.city"
    | "meta.project.country"
    | "meta.project.countryCode"
    | "meta.project.administrative"
    | "meta.project.district"
    | "meta.project.postcode"
    | "meta.project.value"
    | "meta.project.place_id"
    | "meta.project.base_address"
    | "meta.project.latlng.lat"
    | "meta.project.latlng.lng"
    | "output.recoups"
    | "output.notes"
    | "output.f280.rooms.name"
    | "output.f280.heat_loss_w"
    | "output.f280.heat_gain_w"
    | "output.f280.rooms.heat_loss_w"
    | "output.f280.rooms.heat_gain_w"
    | "output.f280.outdoor.design_heating_temperature_C"
    | "output.f280.outdoor.design_cooling_temperature_C"
    | "output.f280.outdoor.deep_ground_temperature_C"
    | "output.f280.outdoor.station_name"
    | "output.f280.outdoor.HDD_18C"
    | "output.f280.indoor.occupants"
    | "output.f280.indoor.design_heating_temperature_C"
    | "output.f280.indoor.design_cooling_temperature_C"
    | "output.f280.indoor.HRV_ef"
    | "output.f280.indoor.HRV_ATRE"
    | "output.bc_metrics.total_heated_area"
    | "output.bc_metrics.TEDI"
    | "output.bc_metrics.eTEDI"
    | "output.bc_metrics.MEUI"
    | "output.bc_metrics.ERS"
    | "output.bc_metrics.ERS_ref"
    | "output.bc_metrics.TEDI_ref"
    | "output.bc_metrics.eTEDI_ref"
    | "output.bc_metrics.auxiliary_heating_required_kWh"
    | "output.bc_metrics.ERS_kWh"
    | "output.bc_metrics.baseload"
    | "output.bc_metrics.AEC"
    | "output.bc_metrics.due"
    | "output.costs.labour"
    | "output.costs.materials"
    | "output.costs.total"
    | "output.costs.embodied"
    | "output.costs.sum1k"
    | "output.costs.itemized.name"
    | "output.costs.itemized.labour"
    | "output.costs.itemized.materials"
    | "output.costs.itemized.substance"
    | "output.costs.itemized.total"
    | "output.costs.itemized.embodied"
    | "output.costs.itemized.unit"
    | "output.costs.itemized.dimension"
    | "output.costs.categories.aux.labour"
    | "output.costs.categories.aux.materials"
    | "output.costs.categories.aux.total"
    | "output.costs.categories.aux.embodied"
    | "output.costs.categories.dhw.labour"
    | "output.costs.categories.dhw.materials"
    | "output.costs.categories.dhw.total"
    | "output.costs.categories.dhw.embodied"
    | "output.costs.categories.hrv.labour"
    | "output.costs.categories.hrv.materials"
    | "output.costs.categories.hrv.total"
    | "output.costs.categories.hrv.embodied"
    | "output.costs.categories.mech.labour"
    | "output.costs.categories.mech.materials"
    | "output.costs.categories.mech.total"
    | "output.costs.categories.mech.embodied"
    | "output.costs.categories.ach.labour"
    | "output.costs.categories.ach.materials"
    | "output.costs.categories.ach.total"
    | "output.costs.categories.ach.embodied"
    | "output.costs.categories.wall.labour"
    | "output.costs.categories.wall.materials"
    | "output.costs.categories.wall.total"
    | "output.costs.categories.wall.embodied"
    | "output.costs.categories.window.labour"
    | "output.costs.categories.window.materials"
    | "output.costs.categories.window.total"
    | "output.costs.categories.window.embodied"
    | "output.costs.categories.windowSHGC.labour"
    | "output.costs.categories.windowSHGC.materials"
    | "output.costs.categories.windowSHGC.total"
    | "output.costs.categories.windowSHGC.embodied"
    | "output.costs.categories.attic.labour"
    | "output.costs.categories.attic.materials"
    | "output.costs.categories.attic.total"
    | "output.costs.categories.attic.embodied"
    | "output.costs.categories.slab.labour"
    | "output.costs.categories.slab.materials"
    | "output.costs.categories.slab.total"
    | "output.costs.categories.slab.embodied"
    | "output.energy_cost.total"
    | "output.energy_cost.costs.electric.Jan"
    | "output.energy_cost.costs.electric.Feb"
    | "output.energy_cost.costs.electric.Mar"
    | "output.energy_cost.costs.electric.Apr"
    | "output.energy_cost.costs.electric.May"
    | "output.energy_cost.costs.electric.Jun"
    | "output.energy_cost.costs.electric.Jul"
    | "output.energy_cost.costs.electric.Aug"
    | "output.energy_cost.costs.electric.Sep"
    | "output.energy_cost.costs.electric.Oct"
    | "output.energy_cost.costs.electric.Nov"
    | "output.energy_cost.costs.electric.Dec"
    | "output.energy_cost.costs.gas.Jan"
    | "output.energy_cost.costs.gas.Feb"
    | "output.energy_cost.costs.gas.Mar"
    | "output.energy_cost.costs.gas.Apr"
    | "output.energy_cost.costs.gas.May"
    | "output.energy_cost.costs.gas.Jun"
    | "output.energy_cost.costs.gas.Jul"
    | "output.energy_cost.costs.gas.Aug"
    | "output.energy_cost.costs.gas.Sep"
    | "output.energy_cost.costs.gas.Oct"
    | "output.energy_cost.costs.gas.Nov"
    | "output.energy_cost.costs.gas.Dec"
    | "output.energy_cost.costs.wood.Jan"
    | "output.energy_cost.costs.wood.Feb"
    | "output.energy_cost.costs.wood.Mar"
    | "output.energy_cost.costs.wood.Apr"
    | "output.energy_cost.costs.wood.May"
    | "output.energy_cost.costs.wood.Jun"
    | "output.energy_cost.costs.wood.Jul"
    | "output.energy_cost.costs.wood.Aug"
    | "output.energy_cost.costs.wood.Sep"
    | "output.energy_cost.costs.wood.Oct"
    | "output.energy_cost.costs.wood.Nov"
    | "output.energy_cost.costs.wood.Dec"
    | "output.energy_cost.costs.propane.Jan"
    | "output.energy_cost.costs.propane.Feb"
    | "output.energy_cost.costs.propane.Mar"
    | "output.energy_cost.costs.propane.Apr"
    | "output.energy_cost.costs.propane.May"
    | "output.energy_cost.costs.propane.Jun"
    | "output.energy_cost.costs.propane.Jul"
    | "output.energy_cost.costs.propane.Aug"
    | "output.energy_cost.costs.propane.Sep"
    | "output.energy_cost.costs.propane.Oct"
    | "output.energy_cost.costs.propane.Nov"
    | "output.energy_cost.costs.propane.Dec"
    | "output.energy_cost.costs.oil.Jan"
    | "output.energy_cost.costs.oil.Feb"
    | "output.energy_cost.costs.oil.Mar"
    | "output.energy_cost.costs.oil.Apr"
    | "output.energy_cost.costs.oil.May"
    | "output.energy_cost.costs.oil.Jun"
    | "output.energy_cost.costs.oil.Jul"
    | "output.energy_cost.costs.oil.Aug"
    | "output.energy_cost.costs.oil.Sep"
    | "output.energy_cost.costs.oil.Oct"
    | "output.energy_cost.costs.oil.Nov"
    | "output.energy_cost.costs.oil.Dec"
    | "output.energy_cost.costs.combined.Jan"
    | "output.energy_cost.costs.combined.Feb"
    | "output.energy_cost.costs.combined.Mar"
    | "output.energy_cost.costs.combined.Apr"
    | "output.energy_cost.costs.combined.May"
    | "output.energy_cost.costs.combined.Jun"
    | "output.energy_cost.costs.combined.Jul"
    | "output.energy_cost.costs.combined.Aug"
    | "output.energy_cost.costs.combined.Sep"
    | "output.energy_cost.costs.combined.Oct"
    | "output.energy_cost.costs.combined.Nov"
    | "output.energy_cost.costs.combined.Dec"
    | "output.energy_cost.per_consumer.electric.aux"
    | "output.energy_cost.per_consumer.electric.dhw"
    | "output.energy_cost.per_consumer.electric.mech"
    | "output.energy_cost.per_consumer.electric.baseload"
    | "output.energy_cost.per_consumer.gas.aux"
    | "output.energy_cost.per_consumer.gas.dhw"
    | "output.energy_cost.per_consumer.gas.mech"
    | "output.energy_cost.per_consumer.gas.baseload"
    | "output.energy_cost.per_consumer.wood.aux"
    | "output.energy_cost.per_consumer.wood.dhw"
    | "output.energy_cost.per_consumer.wood.mech"
    | "output.energy_cost.per_consumer.wood.baseload"
    | "output.energy_cost.per_consumer.propane.aux"
    | "output.energy_cost.per_consumer.propane.dhw"
    | "output.energy_cost.per_consumer.propane.mech"
    | "output.energy_cost.per_consumer.propane.baseload"
    | "output.energy_cost.per_consumer.oil.aux"
    | "output.energy_cost.per_consumer.oil.dhw"
    | "output.energy_cost.per_consumer.oil.mech"
    | "output.energy_cost.per_consumer.oil.baseload"
    | "output.energy_cost.per_consumer.combined.aux"
    | "output.energy_cost.per_consumer.combined.dhw"
    | "output.energy_cost.per_consumer.combined.mech"
    | "output.energy_cost.per_consumer.combined.baseload"
    | "output.rebates.total"
    | "output.rebates.all_rebates.source"
    | "output.rebates.all_rebates.notes"
    | "output.rebates.all_rebates.total"
    | "output.rebates.all_rebates._"
    | "output.rebates.all_rebates.source_link"
    | "output.detailed.heat_loss_assembly_GJ.windows"
    | "output.detailed.heat_loss_assembly_GJ.doors"
    | "output.detailed.heat_loss_assembly_GJ.ponyWall"
    | "output.detailed.heat_loss_assembly_GJ.exposedFloors"
    | "output.detailed.heat_loss_assembly_GJ.total"
    | "output.detailed.heat_loss_assembly_GJ.slab"
    | "output.detailed.heat_loss_assembly_GJ.ceiling"
    | "output.detailed.heat_loss_assembly_GJ.mainWalls"
    | "output.detailed.heat_loss_assembly_GJ.crawlspace"
    | "output.detailed.heat_loss_assembly_GJ.basementBelowGradeWall"
    | "output.detailed.heat_loss_assembly_GJ.basementAboveGradeWall"
    | "output.detailed.heat_loss_assembly_GJ.basementFloorHeaders"
    | "output.detailed.heat_loss_assembly_GJ.floorsAboveBasement"
    | "output.detailed.heat_loss_assembly_GJ.airLeakageAndNaturalVentilation"
    | "output.detailed.heat_loss_month_MJ.january"
    | "output.detailed.heat_loss_month_MJ.february"
    | "output.detailed.heat_loss_month_MJ.march"
    | "output.detailed.heat_loss_month_MJ.april"
    | "output.detailed.heat_loss_month_MJ.may"
    | "output.detailed.heat_loss_month_MJ.june"
    | "output.detailed.heat_loss_month_MJ.july"
    | "output.detailed.heat_loss_month_MJ.august"
    | "output.detailed.heat_loss_month_MJ.september"
    | "output.detailed.heat_loss_month_MJ.october"
    | "output.detailed.heat_loss_month_MJ.november"
    | "output.detailed.heat_loss_month_MJ.december"
    | "output.detailed.utilized_internal_month_MJ.january"
    | "output.detailed.utilized_internal_month_MJ.february"
    | "output.detailed.utilized_internal_month_MJ.march"
    | "output.detailed.utilized_internal_month_MJ.april"
    | "output.detailed.utilized_internal_month_MJ.may"
    | "output.detailed.utilized_internal_month_MJ.june"
    | "output.detailed.utilized_internal_month_MJ.july"
    | "output.detailed.utilized_internal_month_MJ.august"
    | "output.detailed.utilized_internal_month_MJ.september"
    | "output.detailed.utilized_internal_month_MJ.october"
    | "output.detailed.utilized_internal_month_MJ.november"
    | "output.detailed.utilized_internal_month_MJ.december"
    | "output.detailed.utilized_solar_month_MJ.january"
    | "output.detailed.utilized_solar_month_MJ.february"
    | "output.detailed.utilized_solar_month_MJ.march"
    | "output.detailed.utilized_solar_month_MJ.april"
    | "output.detailed.utilized_solar_month_MJ.may"
    | "output.detailed.utilized_solar_month_MJ.june"
    | "output.detailed.utilized_solar_month_MJ.july"
    | "output.detailed.utilized_solar_month_MJ.august"
    | "output.detailed.utilized_solar_month_MJ.september"
    | "output.detailed.utilized_solar_month_MJ.october"
    | "output.detailed.utilized_solar_month_MJ.november"
    | "output.detailed.utilized_solar_month_MJ.december"
    | "output.detailed.per_fuel_consumer_yearly_GJ.electric.aux"
    | "output.detailed.per_fuel_consumer_yearly_GJ.electric.dhw"
    | "output.detailed.per_fuel_consumer_yearly_GJ.electric.mech"
    | "output.detailed.per_fuel_consumer_yearly_GJ.electric.baseload"
    | "output.detailed.per_fuel_consumer_yearly_GJ.gas.aux"
    | "output.detailed.per_fuel_consumer_yearly_GJ.gas.dhw"
    | "output.detailed.per_fuel_consumer_yearly_GJ.gas.mech"
    | "output.detailed.per_fuel_consumer_yearly_GJ.gas.baseload"
    | "output.detailed.per_fuel_consumer_yearly_GJ.wood.aux"
    | "output.detailed.per_fuel_consumer_yearly_GJ.wood.dhw"
    | "output.detailed.per_fuel_consumer_yearly_GJ.wood.mech"
    | "output.detailed.per_fuel_consumer_yearly_GJ.wood.baseload"
    | "output.detailed.per_fuel_consumer_yearly_GJ.propane.aux"
    | "output.detailed.per_fuel_consumer_yearly_GJ.propane.dhw"
    | "output.detailed.per_fuel_consumer_yearly_GJ.propane.mech"
    | "output.detailed.per_fuel_consumer_yearly_GJ.propane.baseload"
    | "output.detailed.per_fuel_consumer_yearly_GJ.oil.aux"
    | "output.detailed.per_fuel_consumer_yearly_GJ.oil.dhw"
    | "output.detailed.per_fuel_consumer_yearly_GJ.oil.mech"
    | "output.detailed.per_fuel_consumer_yearly_GJ.oil.baseload"
    | "output.detailed.totals.electric_yearly_GJ"
    | "output.detailed.totals.gas_yearly_GJ"
    | "output.detailed.totals.wood_yearly_GJ"
    | "output.detailed.totals.propane_yearly_GJ"
    | "output.detailed.totals.oil_yearly_GJ"
    | "output.detailed.totals.equivalent_leakage_area"
    | "output.detailed.totals.ac_yearly_GJ"
    | "output.detailed.totals.heat_loss_year_MJ"
    | "output.detailed.totals.utilized_internal_year_MJ"
    | "output.detailed.totals.utilized_solar_year_MJ"
    | "output.design.gross_space_heat_lo_GJ_yr"
    | "output.design.gross_space_heating_load_GJ_yr"
    | "output.design.usable_internal_gains_GJ_yr"
    | "output.design.usable_solar_gains_GJ_yr"
    | "output.design.aux_energy_required_GJ_yr"
    | "output.design.space_heating_consumption_kWh_yr"
    | "output.design.DHW_consumption_kWh_yr"
    | "output.design.GHG_t_yr"
    | "output.design.design_heat_loss_t"
    | "output.design.design_heat_loss_w"
    | "output.design.design_cooling_load_t"
    | "output.design.design_cooling_load_w"
    | "output.design.design_cooling_capacity_w"
    | "output.design.energy_consumption_monthly_MJ.dhw.Jan"
    | "output.design.energy_consumption_monthly_MJ.dhw.Feb"
    | "output.design.energy_consumption_monthly_MJ.dhw.Mar"
    | "output.design.energy_consumption_monthly_MJ.dhw.Apr"
    | "output.design.energy_consumption_monthly_MJ.dhw.May"
    | "output.design.energy_consumption_monthly_MJ.dhw.Jun"
    | "output.design.energy_consumption_monthly_MJ.dhw.Jul"
    | "output.design.energy_consumption_monthly_MJ.dhw.Aug"
    | "output.design.energy_consumption_monthly_MJ.dhw.Sep"
    | "output.design.energy_consumption_monthly_MJ.dhw.Oct"
    | "output.design.energy_consumption_monthly_MJ.dhw.Nov"
    | "output.design.energy_consumption_monthly_MJ.dhw.Dec"
    | "output.design.energy_consumption_monthly_MJ.dhw.Total"
    | "output.design.energy_consumption_monthly_MJ.hrv.Jan"
    | "output.design.energy_consumption_monthly_MJ.hrv.Feb"
    | "output.design.energy_consumption_monthly_MJ.hrv.Mar"
    | "output.design.energy_consumption_monthly_MJ.hrv.Apr"
    | "output.design.energy_consumption_monthly_MJ.hrv.May"
    | "output.design.energy_consumption_monthly_MJ.hrv.Jun"
    | "output.design.energy_consumption_monthly_MJ.hrv.Jul"
    | "output.design.energy_consumption_monthly_MJ.hrv.Aug"
    | "output.design.energy_consumption_monthly_MJ.hrv.Sep"
    | "output.design.energy_consumption_monthly_MJ.hrv.Oct"
    | "output.design.energy_consumption_monthly_MJ.hrv.Nov"
    | "output.design.energy_consumption_monthly_MJ.hrv.Dec"
    | "output.design.energy_consumption_monthly_MJ.hrv.Total"
    | "output.design.energy_consumption_monthly_MJ.heating.Jan"
    | "output.design.energy_consumption_monthly_MJ.heating.Feb"
    | "output.design.energy_consumption_monthly_MJ.heating.Mar"
    | "output.design.energy_consumption_monthly_MJ.heating.Apr"
    | "output.design.energy_consumption_monthly_MJ.heating.May"
    | "output.design.energy_consumption_monthly_MJ.heating.Jun"
    | "output.design.energy_consumption_monthly_MJ.heating.Jul"
    | "output.design.energy_consumption_monthly_MJ.heating.Aug"
    | "output.design.energy_consumption_monthly_MJ.heating.Sep"
    | "output.design.energy_consumption_monthly_MJ.heating.Oct"
    | "output.design.energy_consumption_monthly_MJ.heating.Nov"
    | "output.design.energy_consumption_monthly_MJ.heating.Dec"
    | "output.design.energy_consumption_monthly_MJ.heating.Total"
    | "output.design.energy_consumption_monthly_MJ.heating_secondary.Jan"
    | "output.design.energy_consumption_monthly_MJ.heating_secondary.Feb"
    | "output.design.energy_consumption_monthly_MJ.heating_secondary.Mar"
    | "output.design.energy_consumption_monthly_MJ.heating_secondary.Apr"
    | "output.design.energy_consumption_monthly_MJ.heating_secondary.May"
    | "output.design.energy_consumption_monthly_MJ.heating_secondary.Jun"
    | "output.design.energy_consumption_monthly_MJ.heating_secondary.Jul"
    | "output.design.energy_consumption_monthly_MJ.heating_secondary.Aug"
    | "output.design.energy_consumption_monthly_MJ.heating_secondary.Sep"
    | "output.design.energy_consumption_monthly_MJ.heating_secondary.Oct"
    | "output.design.energy_consumption_monthly_MJ.heating_secondary.Nov"
    | "output.design.energy_consumption_monthly_MJ.heating_secondary.Dec"
    | "output.design.energy_consumption_monthly_MJ.heating_secondary.Total"
    | "output.design.energy_consumption_monthly_MJ.dhw_secondary.Jan"
    | "output.design.energy_consumption_monthly_MJ.dhw_secondary.Feb"
    | "output.design.energy_consumption_monthly_MJ.dhw_secondary.Mar"
    | "output.design.energy_consumption_monthly_MJ.dhw_secondary.Apr"
    | "output.design.energy_consumption_monthly_MJ.dhw_secondary.May"
    | "output.design.energy_consumption_monthly_MJ.dhw_secondary.Jun"
    | "output.design.energy_consumption_monthly_MJ.dhw_secondary.Jul"
    | "output.design.energy_consumption_monthly_MJ.dhw_secondary.Aug"
    | "output.design.energy_consumption_monthly_MJ.dhw_secondary.Sep"
    | "output.design.energy_consumption_monthly_MJ.dhw_secondary.Oct"
    | "output.design.energy_consumption_monthly_MJ.dhw_secondary.Nov"
    | "output.design.energy_consumption_monthly_MJ.dhw_secondary.Dec"
    | "output.design.energy_consumption_monthly_MJ.dhw_secondary.Total"
    | "output.design.energy_consumption_monthly_MJ.appliances.Jan"
    | "output.design.energy_consumption_monthly_MJ.appliances.Feb"
    | "output.design.energy_consumption_monthly_MJ.appliances.Mar"
    | "output.design.energy_consumption_monthly_MJ.appliances.Apr"
    | "output.design.energy_consumption_monthly_MJ.appliances.May"
    | "output.design.energy_consumption_monthly_MJ.appliances.Jun"
    | "output.design.energy_consumption_monthly_MJ.appliances.Jul"
    | "output.design.energy_consumption_monthly_MJ.appliances.Aug"
    | "output.design.energy_consumption_monthly_MJ.appliances.Sep"
    | "output.design.energy_consumption_monthly_MJ.appliances.Oct"
    | "output.design.energy_consumption_monthly_MJ.appliances.Nov"
    | "output.design.energy_consumption_monthly_MJ.appliances.Dec"
    | "output.design.energy_consumption_monthly_MJ.appliances.Total"
    | "output.design.energy_consumption_monthly_MJ.cooling.Jan"
    | "output.design.energy_consumption_monthly_MJ.cooling.Feb"
    | "output.design.energy_consumption_monthly_MJ.cooling.Mar"
    | "output.design.energy_consumption_monthly_MJ.cooling.Apr"
    | "output.design.energy_consumption_monthly_MJ.cooling.May"
    | "output.design.energy_consumption_monthly_MJ.cooling.Jun"
    | "output.design.energy_consumption_monthly_MJ.cooling.Jul"
    | "output.design.energy_consumption_monthly_MJ.cooling.Aug"
    | "output.design.energy_consumption_monthly_MJ.cooling.Sep"
    | "output.design.energy_consumption_monthly_MJ.cooling.Oct"
    | "output.design.energy_consumption_monthly_MJ.cooling.Nov"
    | "output.design.energy_consumption_monthly_MJ.cooling.Dec"
    | "output.design.energy_consumption_monthly_MJ.cooling.Total"
    | `house.walls.helpers.${string}`
    | `house.attics.helpers.${string}`
    | `house.decks.helpers.${string}`
    | `house.cathedrals.helpers.${string}`
    | `house.basements.helpers.${string}`
    | `house.crawlSpaces.helpers.${string}`
    | `house.SOGs.helpers.${string}`
    | `house.exposedFloors.helpers.${string}`
    | "house.weather.station_name"
    | "house.weather.HDD_18C"
    | "house.weather.province_code"
    | "house.weather.station_code"
    | "house.weather.province_name"
    | "house.weather.HDD_19C"
    | "house.weather.HDD_20C"
    | "house.weather.times_heating_20C"
    | "house.weather.frost"
    | "house.weather.latitude"
    | "house.weather.loads.solarRad.global"
    | "house.weather.loads.solarRad.diffuse"
    | "house.weather.loads.solarRad.south"
    | "house.weather.loads.solarRad.sesw"
    | "house.weather.loads.solarRad.eastwest"
    | "house.weather.loads.solarRad.nenw"
    | "house.weather.loads.solarRad.north"
)[] = ...

saves revisions for Activity pre and post upgrade

Optionalrun

run?: string

seed_version

seed_version: string = SEED_VERSION

swaps

swaps: SeedSwaps = ...

Specifies any swaps to be used in the seed.

See the Seed Documentation for more information.

token

token: string = ''

units

units: string = 'metric'

Optionalwizard

wizard?: {
    additional?: {
        ac: boolean;
        hp?: boolean | "N/A";
        "N/A": boolean;
        natural_gas_fireplace: boolean;
        solar: boolean;
        wood_fireplace: boolean;
    };
    excluded_upgrades?: string[];
    excludeExistingCondition: boolean;
    fuel?: "gas"
    | "wood"
    | "propane"
    | "oil"
    | "other"
    | "electricity"
    | "N/A";
    glassPanes?: number | "N/A";
    hotWaterFuel?:
        | "gas"
        | "wood"
        | "propane"
        | "oil"
        | "other"
        | "electricity"
        | "N/A";
    replaced?: {
        ach: boolean;
        dhw: boolean;
        heating: boolean;
        "N/A": boolean;
        other: boolean;
        roof_insulation: boolean;
        vent: boolean;
        wall_insulation: boolean;
        window: boolean;
    };
}

Optional inputs for better completeSeed assumptions

Settings

Member Visibility

On This Page

Constructors
Properties