main

honeybee-doe2

honeybee doe2 commands.

honeybee-doe2 [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

translate

Commands for translating Honeybee Model to DOE-2 formats.

honeybee-doe2 translate [OPTIONS] COMMAND [ARGS]...

hbjson-to-inp

Translate a Model (HBJSON) file to an INP file.

Args:

model_file: Full path to a Honeybee Model file (HBJSON or HBpkl).

honeybee-doe2 translate hbjson-to-inp [OPTIONS] MODEL_FILE

Options

-hm, --hvac-mapping <hvac_mapping>

Text to indicate how HVAC systems should be assigned to the exported model. Story will assign one HVAC system for each distinct level polygon, Model will use only one HVAC system for the whole model and AssignedHVAC will follow how the HVAC systems have been assigned to theRooms.properties.energy.hvac. Choose from: Room, Story, Model, AssignedHVAC

Default:

'Story'

--include-interior-walls, -xw, --exclude-interior-walls

Flag to note whether interior walls should be excluded from the export.

Default:

True

--include-interior-ceilings, -xc, --exclude-interior-ceilings

Flag to note whether interior ceilings should be excluded from the export.

Default:

True

--verbose-properties, -ss, --switch-statements

Flag to note whether program types should be written with switch statements so that they can easily be edited in eQuest or a verbose definition of loads should be written for each Room/Space.

Default:

True

-n, --name <name>

Deprecated option to set the name of the output file.

-f, --folder <folder>

Deprecated option to set the path to target folder.

-o, --output-file <output_file>

Optional INP file path to output the INP string of the translation. By default this will be printed out to stdout.

Default:

'-'

Arguments

MODEL_FILE

Required argument

model-to-inp

Translate a Model (HBJSON) file to an INP file.

Args:

model_file: Full path to a Honeybee Model file (HBJSON or HBpkl).

honeybee-doe2 translate model-to-inp [OPTIONS] MODEL_FILE

Options

-sp, --sim-par-json <sim_par_json>

Full path to a honeybee-doe2 SimulationPar JSON that describes all of the settings for the simulation. If unspecified, default parameters will be generated.

-hm, --hvac-mapping <hvac_mapping>

Text to indicate how HVAC systems should be assigned to the exported model. Story will assign one HVAC system for each distinct level polygon, Model will use only one HVAC system for the whole model and AssignedHVAC will follow how the HVAC systems have been assigned to theRooms.properties.energy.hvac. Choose from: Room, Story, Model, AssignedHVAC

Default:

'Story'

--include-interior-walls, -xw, --exclude-interior-walls

Flag to note whether interior walls should be excluded from the export.

Default:

True

--include-interior-ceilings, -xc, --exclude-interior-ceilings

Flag to note whether interior ceilings should be excluded from the export.

Default:

True

-eq, --equest-version <equest_version>

optional text string to denote the version of eQuest for which the INP definition will be generated. If unspecified or unrecognized, the latest version of eQuest will be used.

Default:

'3.65'

-o, --output-file <output_file>

Optional INP file path to output the INP string of the translation. By default this will be printed out to stdout.

Default:

'-'

Arguments

MODEL_FILE

Required argument

schedules-from-inp

Translate a schedule INP file to a honeybee JSON as an array of schedules.

Args:

schedule_inp: Full path to a Schedule INP file.

honeybee-doe2 translate schedules-from-inp [OPTIONS] SCHEDULE_INP

Options

--dictionary, -l, --list

Flag to note whether a the output JSON should be a list of schedule objects or whether it should be a dictionary where each key is the identifier of the schedule and each value is the schedule object. The dictionary format is the one used by honeybee-standards and is recommended when writing INP schedules into the user standards library.

Default:

True

-f, --output-file <output_file>

Optional JSON file to output the JSON string of the translation. By default this will be printed out to stdout

Default:

'-'

Arguments

SCHEDULE_INP

Required argument

schedules-to-inp

Translate a Schedule JSON file to an INP.

Args:

schedule_json: Full path to a Schedule JSON file. This file should

either be an array of non-abridged Schedules or a dictionary where

the values are non-abridged Schedules.

honeybee-doe2 translate schedules-to-inp [OPTIONS] SCHEDULE_JSON

Options

-f, --output-file <output_file>

Optional INP file to output the INP string of the translation. By default this will be printed out to stdout

Default:

'-'

Arguments

SCHEDULE_JSON

Required argument