translate¶

honeybee-doe2 translate¶

Commands for translating Honeybee Model to DOE-2 formats.

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

constructions-from-inp¶

Translate all constructions in an INP file to a honeybee JSON.

Args:

construction_inp: Full path to a Construction INP file.

honeybee-doe2 translate constructions-from-inp [OPTIONS] CONSTRUCTION_INP

Options

--full, -a, --abridged¶

Flag to note whether the objects should be translated as an abridged specification instead of a specification that fully describes the object. This option should be used when the materials-from-inp command will be used to separately translate all of the materials from the INP.

Default:: True

--dictionary, -a, --array¶

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

Default:: True

-i, --indent <indent>¶: Optional integer to specify the indentation in the output JSON file. Specifying an value here can produce more read-able JSONs.

-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

CONSTRUCTION_INP¶: Required argument

constructions-to-inp¶

Translate a Construction JSON file to an INP.

Args:

construction_json: Full path to a Construction JSON file. This file should

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

the values are non-abridged Constructions.

honeybee-doe2 translate constructions-to-inp [OPTIONS] CONSTRUCTION_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

CONSTRUCTION_JSON¶: Required argument

materials-from-inp¶

Translate all materials in an INP file to a honeybee JSON.

Args:

material_inp: Full path to an INP file. Only the materials in this file

will be extracted.

honeybee-doe2 translate materials-from-inp [OPTIONS] MATERIAL_INP

Options

--dictionary, -a, --array¶

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

Default:: True

-i, --indent <indent>¶: Optional integer to specify the indentation in the output JSON file. Specifying an value here can produce more read-able JSONs.

-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

MATERIAL_INP¶: Required argument

model-from-inp¶

Translate an INP file to a Honeybee Model as a HBJSON.

Args:

inp_file: Full path to an INP file.

honeybee-doe2 translate model-from-inp [OPTIONS] INP_FILE

Options

-o, --output-file <output_file>¶

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

Default:: '-'

Arguments

INP_FILE¶: Required argument

model-to-inp¶

Translate a Honeybee Model 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 all schedules in an INP file to a honeybee JSON.

Args:

schedule_inp: Full path to a Schedule INP file.

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

Options

--dictionary, -a, --array¶

Flag to note whether a the output JSON should be an array 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

-i, --indent <indent>¶: Optional integer to specify the indentation in the output JSON file. Specifying an value here can produce more read-able JSONs.

-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