lib¶

honeybee-radiance lib¶

Commands for retrieving objects from the standards library.

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

modifier-by-id¶

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

Args:: modifier_id: The identifier of a modifier in the library.

honeybee-radiance lib modifier-by-id [OPTIONS] MODIFIER_ID

Options

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

MODIFIER_ID¶: Required argument

modifier-set-by-id¶

Get an modifier set definition from the standards lib with its identifier.

Args:: modifier_set_id: The identifier of a modifier set in the library.

honeybee-radiance lib modifier-set-by-id [OPTIONS] MODIFIER_SET_ID

Options

--none-defaults <none_defaults>¶

Boolean to note whether default modifiers in the set should be included in detail (False) or should be None (True).

Default: True

--abridged <abridged>¶

Optional boolean to note wether an abridged definition should be returned.

Default: False

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

MODIFIER_SET_ID¶: Required argument

modifier-sets¶

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

honeybee-radiance lib modifier-sets [OPTIONS]

Options

--output-file <output_file>¶

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

Default: -

modifier-sets-by-id¶

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

Args:

modifier_set_ids: A list of modifier set identifiers to be retrieved: from the library.

honeybee-radiance lib modifier-sets-by-id [OPTIONS] [MODIFIER_SET_IDS]...

Options

--none-defaults <none_defaults>¶

Boolean to note whether default modifiers in the set should be included in detail (False) or should be None (True).

Default: True

--abridged <abridged>¶

Optional boolean to note wether an abridged definition should be returned.

Default: False

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

MODIFIER_SET_IDS¶: Optional argument(s)

modifiers¶

Get a list of all modifiers in the standards library.

honeybee-radiance lib modifiers [OPTIONS]

Options

--output-file <output_file>¶

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

Default: -

modifiers-by-id¶

Get several modifier definitions from the standards lib at once.

Args:: modifier_ids: A list of modifier identifiers to be retrieved from the library.

honeybee-radiance lib modifiers-by-id [OPTIONS] [MODIFIER_IDS]...

Options

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

MODIFIER_IDS¶: Optional argument(s)

to-model-properties¶

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

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 ModelRadianceProperties will be abridged and duplicated objects in the folder will be removed such that there is only one of each object.

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

Options

-s, --standards-folder <standards_folder>¶: A directory containing subfolders of resource objects (modifiers, modifiersets) to be loaded as ModelRadianceProperties. Note that this standards folder MUST contain these subfolders. Each sub-folder can contain JSON files of objects following honeybee schema or RAD/MAT 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: -