main¶
ladybug-rhino¶
ladybug-rhino [OPTIONS] COMMAND [ARGS]...
Options
- --version¶
Show the version and exit.
viz¶
Check if ladybug_rhino is flying!
ladybug-rhino viz [OPTIONS]
setup-user-environment¶
Set up the entire environment for the current user.
This includes setting the IronPython search path, copying the components to the user-specific folders, and creating any user resource folders if they do not already exist. Note that setting the IronPython search path won’t work well if Rhino is open while running this command.
ladybug-rhino setup-user-environment [OPTIONS]
Options
- --component-directory <component_directory>¶
The path to a directory that contains all of the Ladybug Tools Grasshopper python packages to be copied (both user object packages and dotnet gha packages). If unspecified, this command will search for the site-packages folder in the ladybug_tools folder. If they are not found, no user objects will be copied.
- --python-package-dir <python_package_dir>¶
Path to the directory with the python packages, which will be added to the search path. If unspecified, this command will search for the site-packages folder in the ladybug_tools folder.
- --setup-resources, -o, --overwrite-resources¶
Flag to note whether the user resources should be overwritten or they should only be set up if they do not exist, in which case existing resources will be preserved.
set-python-search¶
Set Rhino to search for libraries in a given directory.
ladybug-rhino set-python-search [OPTIONS]
Options
- --python-package-dir <python_package_dir>¶
Path to the directory with the python packages, which will be added to the search path. If None, this command will search for the site-packages folder in the ladybug_tools folder
- --settings-file <settings_file>¶
Path to the Rhino settings file to which the python-package-dir will be added. If None, this command will search the current user folder for all copies of this file for the installed Rhino versions.
copy-gh-components¶
Copy all component packages to the UserObjects and Libraries folder.
ladybug-rhino copy-gh-components [OPTIONS] COMPONENT_DIRECTORY
Arguments
- COMPONENT_DIRECTORY¶
Required argument
remove-gh-components¶
Remove all component packages to the UserObjects and Libraries folder.
ladybug-rhino remove-gh-components [OPTIONS]
setup-resources¶
Set up user resource folders in their respective locations.
ladybug-rhino setup-resources [OPTIONS]
Options
- --setup-only, -o, --overwrite¶
Flag to note whether the user resources should be overwritten or they should only be set up if they do not exist, in which case existing resources will be preserved.
change-installed-version¶
Change the currently installed version of Ladybug Tools.
This requires an internet connection and will update all core libraries and Grasshopper components to the specified version_to_install.
ladybug-rhino change-installed-version [OPTIONS]
Options
- -v, --version <version>¶
An optional text string for the version of the LBT plugin to be installed. The input should contain only integers separated by two periods (eg. 1.0.0). If unspecified, the Ladybug Tools plugin shall be updated to the latest available version. The version specified here 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.
config¶
Get a JSON object with all configuration information.
ladybug-rhino config [OPTIONS]
Options
- --output-file <output_file>¶
Optional file to output the JSON string of the config object. By default, it will be printed out to stdout
- Default:
'-'