Ladybug Primer
Ladybug Tools for Grasshopper Documentation
  • Ladybug Primer
  • Components
    • 0 :: Import
      • Download Weather
      • EPWmap
      • Import EPW
      • Import Location
      • Construct Location
      • Deconstruct Location
      • Import DDY
      • Import STAT
      • Deconstruct Design Day
      • Import Design Day
      • EPW to DDY
    • 1 :: Analyze Data
      • Construct Data
      • Construct Data Type
      • Construct Header
      • Deconstruct Data
      • Analysis Period
      • Calculate HOY
      • Apply Analysis Period
      • Apply Conditional Statement
      • Arithmetic Operation
      • Time Interval Operation
      • Degree Days
      • Wind Speed
      • Adaptive Comfort
      • PET Comfort
      • PMV Comfort
      • UTCI Comfort
      • Indoor Solar MRT
      • Outdoor Solar MRT
      • Ankle Draft
      • Clothing by Temperature
      • Comfort Statistics
      • Convert to Timestep
      • Data DateTimes
      • Day Solar Information
      • Deconstruct Header
      • Directional Solar Irradiance
      • HOY to DateTime
      • Humidity Metrics
      • Mass Arithmetic Operation
      • Radiant Asymmetry
      • Relative Humidity from Dew Point
      • Solar MRT from Solar Components
      • Thermal Indices
    • 2 :: Visualize Data
      • Hourly Plot
      • Monthly Chart
      • Adaptive Chart
      • PMV Polygon
      • Psychrometric Chart
      • UTCI Polygon
      • Benefit Sky Matrix
      • Cumulative Sky Matrix
      • Sky Dome
      • SunPath
      • Radiation Dome
      • Radiation Rose
      • Wind Profile
      • Wind Rose
    • 3 :: Analyze Geometry
      • Direct Sun Hours
      • Incident Radiation
      • View Factors
      • View Percent
      • View Rose
      • Visibility Percent
      • Human to Sky Relation
      • Sky Mask
      • Solar Envelope
      • Surface Ray Tracing
      • Shade Benefit
      • Thermal Shade Benefit
      • Set Rhino Sun
      • View From Sun
      • Real Time Incident Radiation
    • 4 :: Extra
      • Color Range
      • FalseStartToggle
      • Generate Point Grid
      • ImageViewer
      • Legend Parameters
      • Mesh Threshold Selector
      • Preview VisualizationSet
      • Spatial Heatmap
      • Capture View
      • Legend 2D Parameters
      • Orient to Camera
      • Set View
      • To IP
      • To SI
      • To Unit
      • Unit Converter
      • Adaptive Comfort Parameters
      • PMV Comfort Parameters
      • Passive Strategies
      • Solar Body Parameters
      • Dump Data
      • Load Data
      • Open Directory
      • Open File
      • Compass
      • Magnetic to True North
      • Activities Met List
      • Area Aggregate
      • Area Normalize
      • Clothing List
      • Construct Matrix
      • Create Legend
      • Deconstruct Matrix
      • Deconstruct VisualizationSet
      • Dump VisualizationSet
      • Filter by Normal
      • Legend Parameters Categorized
      • Mesh to Hatch
      • PET Body Parameters
      • Passive Strategy Parameters
      • Screen Oriented Text
      • SortByLayers
      • Time Aggregate
      • Time Rate of Change
      • UTCI Comfort Parameters
    • 5 :: Version
      • Sync Grasshopper File
      • Versioner
      • Export UserObject
      • Legacy Updater
Powered by GitBook
On this page
  • Inputs
  • Outputs
Export as PDF
  1. Components
  2. 5 :: Version

Export UserObject

PreviousVersionerNextLegacy Updater

Last updated 1 year ago

-

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.

[source code]