lib¶

honeybee-energy lib¶

Commands for retrieving objects from the standards library.

honeybee-energy lib [OPTIONS] COMMAND [ARGS]...

construction-set-by-id¶

Get a construction set definition from the standards lib with its identifier.

Args:

construction_set_id: The identifier of a construction set in the library.

honeybee-energy lib construction-set-by-id [OPTIONS] CONSTRUCTION_SET_ID

Options

--none-defaults, -d, --include-defaults¶

Flag to note whether default constructions in the set should be included in or should be None.

Default: True

--complete, -a, --abridged¶

Flag to note wether an abridged definition should be returned.

Default: True

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

Arguments

CONSTRUCTION_SET_ID¶: Required argument

construction-sets¶

Get a list of all construction sets in the standards library.

honeybee-energy lib construction-sets [OPTIONS]

Options

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

construction-sets-by-id¶

Get several construction set definitions from the standards lib at once.

Args:

construction_set_ids: Any number of construction set identifiers to be retrieved

from the library.

honeybee-energy lib construction-sets-by-id [OPTIONS]
                                            [CONSTRUCTION_SET_IDS]...

Options

--none-defaults, -d, --include-defaults¶

Flag to note whether default constructions in the set should be included in detail or should be None.

Default: True

--complete, -a, --abridged¶

Flag to note wether an abridged definition should be returned.

Default: True

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

Arguments

CONSTRUCTION_SET_IDS¶: Optional argument(s)

constructions-by-id¶

Get several construction definitions from the standards lib at once.

Args:

construction_ids: Any number of construction identifiers to be retrieved

from the library.

honeybee-energy lib constructions-by-id [OPTIONS] [CONSTRUCTION_IDS]...

Options

--complete, -a, --abridged¶

Flag to note wether an abridged definition should be returned.

Default: True

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

Optional file to output the JSON strings of the objects. By default, it will be printed out to stdout

Default: -

Arguments

CONSTRUCTION_IDS¶: Optional argument(s)

materials-by-id¶

Get several material definitions from the standards lib at once.

Args:

material_ids: Any number of material identifiers to be retrieved from

the library.

honeybee-energy lib materials-by-id [OPTIONS] [MATERIAL_IDS]...

Options

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

Optional file to output the JSON strings of the objects. By default, it will be printed out to stdout

Default: -

Arguments

MATERIAL_IDS¶: Optional argument(s)

opaque-construction-by-id¶

Get an opaque construction definition from the standards lib with its identifier.

Args:

construction_id: The identifier of an opaque construction in the library.

honeybee-energy lib opaque-construction-by-id [OPTIONS] CONSTRUCTION_ID

Options

--complete, -a, --abridged¶: Flag to note wether an abridged defintion should be returned.

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

Arguments

CONSTRUCTION_ID¶: Required argument

opaque-constructions¶

Get a list of all opaque constructions in the standards library.

honeybee-energy lib opaque-constructions [OPTIONS]

Options

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

opaque-material-by-id¶

Get an opaque material definition from the standards lib with its identifier.

Args:

material_id: The identifier of an opaque material in the library.

honeybee-energy lib opaque-material-by-id [OPTIONS] MATERIAL_ID

Options

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

Arguments

MATERIAL_ID¶: Required argument

opaque-materials¶

Get a list of all opaque materials in the standards library.

honeybee-energy lib opaque-materials [OPTIONS]

Options

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

program-type-by-id¶

Get a program type definition from the standards lib with its identifier.

Args:

program_type_id: The identifier of a program type in the library.

honeybee-energy lib program-type-by-id [OPTIONS] PROGRAM_TYPE_ID

Options

--complete, -a, --abridged¶

Flag to note wether an abridged definition should be returned.

Default: True

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

Arguments

PROGRAM_TYPE_ID¶: Required argument

program-types¶

Get a list of all program_types in the standards library.

honeybee-energy lib program-types [OPTIONS]

Options

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

program-types-by-id¶

Get several program type definitions from the standards lib at once.

Args:

program_type_ids: Any number of program type identifiers to be retrieved

from the library.

honeybee-energy lib program-types-by-id [OPTIONS] [PROGRAM_TYPE_IDS]...

Options

--complete, -a, --abridged¶

Flag to note wether an abridged definition should be returned.

Default: True

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

Optional file to output the JSON strings of the objects. By default, it will be printed out to stdout

Default: -

Arguments

PROGRAM_TYPE_IDS¶: Optional argument(s)

schedule-by-id¶

Get a schedule definition from the standards lib with its identifier.

Args:

schedule_id: The identifier of a schedule in the library.

honeybee-energy lib schedule-by-id [OPTIONS] SCHEDULE_ID

Options

--complete, -a, --abridged¶

Flag to note wether an abridged definition should be returned.

Default: True

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

Arguments

SCHEDULE_ID¶: Required argument

schedule-type-limit-by-id¶

Get a schedule type limit definition from the standards lib with its identifier.

Args:

schedule_type_limit_id: The identifier of a schedule type limit in the library.

honeybee-energy lib schedule-type-limit-by-id [OPTIONS] SCHEDULE_TYPE_LIMIT_ID

Options

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

Arguments

SCHEDULE_TYPE_LIMIT_ID¶: Required argument

schedule-type-limits¶

Get a list of all schedule type limits in the standards library.

honeybee-energy lib schedule-type-limits [OPTIONS]

Options

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

schedule-type-limits-by-id¶

Get several schedule type limit definitions from the standards lib at once.

Args:

schedule_type_limit_ids: Any number of schedule type limit identifiers to be

retrieved from the library.

honeybee-energy lib schedule-type-limits-by-id [OPTIONS]
                                               [SCHEDULE_TYPE_LIMIT_IDS]...

Options

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

Optional file to output the JSON strings of the objects. By default, it will be printed out to stdout

Default: -

Arguments

SCHEDULE_TYPE_LIMIT_IDS¶: Optional argument(s)

schedules¶

Get a list of all schedules in the standards library.

honeybee-energy lib schedules [OPTIONS]

Options

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

schedules-by-id¶

Get several schedule definitions from the standards lib at once.

Args:

schedule_ids: Any number of schedule identifiers to be retrieved from

the library.

honeybee-energy lib schedules-by-id [OPTIONS] [SCHEDULE_IDS]...

Options

--complete, -a, --abridged¶

Flag to note wether an abridged definition should be returned.

Default: True

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

Optional file to output the JSON strings of the objects. By default, it will be printed out to stdout

Default: -

Arguments

SCHEDULE_IDS¶: Optional argument(s)

shade-construction-by-id¶

Get a shade construction definition from the standards lib with its identifier.

Args:

construction_id: The identifier of a shade construction in the library.

honeybee-energy lib shade-construction-by-id [OPTIONS] CONSTRUCTION_ID

Options

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

Arguments

CONSTRUCTION_ID¶: Required argument

shade-constructions¶

Get a list of all shade constructions in the standards library.

honeybee-energy lib shade-constructions [OPTIONS]

Options

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

to-model-properties¶

Translate a lib folder of standards to a JSON of honeybee ModelEnergyProperties.

This is useful in workflows where one must import everything within a user’s standards folder and requires all objects to be in a consistent format. All objects in the resulting ModelEnergyProperties will be abridged and duplicated objects in the folder will be removed such that there is only one of each object.

honeybee-energy lib to-model-properties [OPTIONS]

Options

-s, --standards-folder <standards_folder>¶: A directory containing subfolders of resource objects (constructions, constructionsets, schedules, programtypes) to be loaded as ModelEnergyProperties. Note that this standards folder MUST contain these subfolders. Each sub-folder can contain JSON files of objects following honeybee schema or IDF files (if appropriate). If None, the honeybee default standards folder will be used.

-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: -

window-construction-by-id¶

Get a window construction definition from the standards lib with its identifier.

Args:

construction_id: The identifier of a window construction in the library.

honeybee-energy lib window-construction-by-id [OPTIONS] CONSTRUCTION_ID

Options

--complete, -a, --abridged¶: Flag to note wether an abridged defintion should be returned.

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

Arguments

CONSTRUCTION_ID¶: Required argument

window-constructions¶

Get a list of all window constructions in the standards library.

honeybee-energy lib window-constructions [OPTIONS]

Options

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

window-material-by-id¶

Get a window material definition from the standards lib with its identifier.

Args:

material_id: The identifier of an window material in the library.

honeybee-energy lib window-material-by-id [OPTIONS] MATERIAL_ID

Options

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -

Arguments

MATERIAL_ID¶: Required argument

window-materials¶

Get a list of all window materials in the standards library.

honeybee-energy lib window-materials [OPTIONS]

Options

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

Optional file to output the JSON string of the object. By default, it will be printed out to stdout

Default: -