lib

honeybee-radiance lib

Commands for retrieving objects from the standards library.

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

add

Add an object or set of objects to the user’s standard library.

Args:

properties_file: A JSON file of a ModelRadianceProperties object containing

the objects to be written into the user standards library. All sub-objects

within this ModelRadianceProperties object must be Abridged if the sub-object

has an abridged schema and these abridged schemas are allowed to

reference either other objects in the ModelRadianceProperties or existing

objects within the standards library.

honeybee-radiance lib add [OPTIONS] PROPERTIES_FILE

Options

-s, --standards-folder <standards_folder>

A directory containing sub-folders of resource objects (modifiers, modifiersets) to which the properties-file objects will be added. If unspecified, the current user honeybee default standards folder will be used.

-log, --log-file <log_file>

Optional file to output a log of the purging process. By default this will be printed out to stdout

Default:

'-'

Arguments

PROPERTIES_FILE

Required argument

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)

purge

Purge the library of all user radiance standards that it contains.

This is useful when a user’s standard library has become filled with duplicated objects or the user wishes to start fresh by re-exporting updated objects.

honeybee-radiance lib purge [OPTIONS]

Options

-s, --standards-folder <standards_folder>

A directory containing sub-folders of resource objects (modifiers, modifiersets) to be purged of files. If unspecified, the current user honeybee default standards folder will be used.

--json-only, -a, --all

Flag to note whether only JSON files should be purged from the library or all files should be purged, including RAD files. Given that all objects added to the library through the add command will always be JSON, only purging the JSONs is useful when one wishes to clear these objects while preserving objects that originated from other sources.

Default:

True

--backup, -xb, --no-backup

Flag to note whether a backup .zip file of the user standards library should be made before the purging operation. This is done by default in case the user ever wants to recover their old standards but can be turned off if a backup is not desired.

Default:

True

-log, --log-file <log_file>

Optional file to output a log of the purging process. By default this will be printed out to stdout

Default:

'-'

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 sub-folders of resource objects (modifiers, modifiersets) to be loaded as ModelRadianceProperties. Note that this standards folder MUST contain these sub-folders. 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.

--exclude-abridged, -a, --include-abridged

Flag to note whether fully abridged objects in the user standards library should be included in the output file. This is useful when some of the sub-objects contained within the user standards are referenced in another installed standards package that is not a part of the user personal standards library (eg. honeybee-standards). When abridged objects are excluded, only objects that contain all sub-objects within the user library will be in the output-file.

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:

'-'