Developer documentation

Building from source

Dependencies

Rhino / Grasshopper (at least v6)

• We need the RhinoCommon.dll and Grasshopper.dll

Hive.IO:

• .NET Framework v4.5
• Nuget Packages (check packages.config for more details):
  • Newtonsoft.JSON
  • OxyPlot.Core
  • OxyPlot.WindowsForms
• Python 2.7 (for some data preparation scripts)
  • Packages
    • pyyaml
    • jsonschema

Setup (see the dedicated readme):

• MSBuild (installed with Visual Studio, assumes v2019 Community)
• Honey Badger
  • honey-badger-runtime.dll is included here and can be downloaded from here
• IronPython 2.7.8 (standalone installation, v2.7.8 for Rhino 6 / 7 compatibility, see honey badger repo readme for details)
• NSIS
• Solar model (the dll and gha are already deposited here in Hive, but the repo is where you could get the newest version)

Source code (hive)

Use setup\build.cmd to build everything and create the installer. It builds:

• src\Hive.Core
• src\Hive.IO
• creates setup\Setup_Hive.exe
• docs for Hive.Core into hive.wiki (assumes hive.wiki repo is in the same location as hive repo!)

Also, if new Hive.Core components are added, they need to be specified in the build.cmd

Wiki (hive.wiki)

The wiki is part of a separate repo called hive.wiki, as this is not part of the regular hive repo in GitHub.

Youu can either edit wiki pages on Github directly or locally by pushing changes to the hive.wiki repo. For the latter, keep in mind that there is only a master branch (so no pull requests) and you can commit directly there. Refer to the Github Docs for how to setup, organise pages, add/edit pages, etc.

Main architecture

Where to find what

Visualizer and plots

• overview of class hierarchy
• how to add a new plot (hand drawn / OxyPlot)