- [source code]

Export a Ladybug Tools Grasshopper GHPython component as a UserObject that can be installed on other's machines.

Inputs

• components [Required]

A Ladybug Tools GHPython component to be exported. This can also be a list of of components to be exported together. Lastly, this can be a "*" and all of the Ladybug Tools components on the Grasshopper canvass will be exported.

• folder [Required]

Full path to folder to copy the updated UserObject and the source code. It is usually path to where you have cloned the repository from GitHub. Exported contents will be created under src and userobject folders.

• change_type

One of the values listed below based on the type of change made to the component. Export component will validate the version of the newly created UserObject against the version of the current installed UserObject with the same name based on the change type. If an older version of the component does not exist the current version of the component will be used. The version is structured as major.minor.patch. (Default: fix)

* release: You are changing the versions for a new release.Bump the major with 1 and set minor and patch to 0. 


* feat: You have added a new feature. Adding a new feature usuallyresults in a change in inputs or outputs of the component. Bump minor by 1 and set patch to 0. 


* perf: You have improved the component for better performance.Similar to adding a feature you should bump the minor by 1 and set patch to 0. 


* fix: You have fixed the code inside the component. It results ina single bump in patch. 


* docs: You have improved the documentation. No change in version.


* ignore: This is an exception to the rule and you want the changetype to be ignored. You should use this option only in rare occasional cases. 

• export [Required]

Set to True to export the component.

Outputs

• report

Errors, warnings, etc.

• Sync Grasshopper File

• Versioner

• Export UserObject

• Legacy Updater

- [source code]

Drop suggested Ladybug Tools components into a Grasshopper file for every Legacy Ladybug + Honeybee component on the canvas.

All existing LBT and native Grasshopper components will be left as they are and only the Legacy components will be circled in Red and have the suggested LBT component placed next to them (if applicable). Note that, after this component runs, you must then connect the new LBT components to the others and delete the Legacy components.

Where applicable, each red circle will have a message about how the LBT component differs from the Legacy one or if there may be a more appropirate LBT component in the future. Also note that some Legacy workflows have been heavily refactored since Legacy, meaning a different number of components may be necessary to achieve the same thing (typically fewer in LBT than Legacy, meaning some LEgacy components should be deleted without replacement).

Inputs

• update [Required]

Set to "True" to have this component to search through the current Grasshopper file and drop suggested Ladybug Tools components for every Legacy Ladybug + Honeybee component on the canvas.

Outputs

• report

Errors, warnings, etc.

- [source code]

Sync the Ladybug Tools components in a Grasshopper file with the version of the components that currently exist in the Grasshopper toolbar.

This is useful for updating old Grasshopper definitions to newer plugin versions. However, this component will sync components regardless of version number or date, even if the components in the toolbar are of an older version than those currently on the Grasshopper canvass.

Any components that cannot be updated automatically (because their inputs or outputs have changed) will be circled in red and should be replaced manually.

Inputs

• sync [Required]

Set to "True" to have this component to search through the current Grasshopper file and sync all Ladybug Tools components with the version in the Grasshopper toolbar.

Outputs

• report

Errors, warnings, etc.

- [source code]

This component updates the Ladybug Tools core libraries and grasshopper components to either the latest development version available (default) or to a specific version of the grasshopper plugin.

The input version_ does not need to be newer than the current installation and can be older but grasshopper plugin versions less than 0.3.0 are not supported. A list of all versions of the Grasshopper plugin and corresponding release notes can be found at: https://github.com/ladybug-tools/lbt-grasshopper/releases

Inputs

• update [Required]

Set to True to update your installation of Ladybug Tools to the latest development version or to be at the version specified below.

• version

An optional text string for the version of the grasshopper plugin which you would like to update to. The input should contain only integers separated by two periods (eg. 1.0.0). The version does not need to be newer than the current installation and can be older but grasshopper plugin versions less than 0.3.0 are not supported. A list of all versions of the Grasshopper plugin can be found here - https://github.com/ladybug-tools/lbt-grasshopper/releases

Outputs

• Vviiiiiz!

!!!