Getting started for developers

Welcome Developers! 🚀

Here's a quick start guide. After reading this, you might want to head to the Introduction to BHoM_Adapter, and then create your own Toolkit.

Building BHoM from Source

Please follow the steps below:

1. Use git clone (or use GitHub desktop) to download the repositories in the list below.
2. Use your preferred IDE to build the solutions in the order as they appear below. We recommend Visual Studio Community.

🚩 Note: Build order 🚩

The first time you build BHoM you need to clone and build the repos in the order specified below. You must pick all the Mandatory repos.

🚩 Note: Rebuilding and seeing changes in the UIs (Grasshopper/Dynamo/Excel) 🚩

When building the project, the compiled assemblies will go in the ./Build folder of your Repo, plus there is a Post-Build event that copies the files in the central BHoM folder: C:\ProgramData\BHoM\Assemblies. When you build, if there is any UI open (e.g. Rhino/Grasshopper/Revit/Excel), the dlls will not be overwritten in the central folder (because they are referenced by the UI software), so you must make sure to close all UI software and reopening it if you want to see updated changes.

A 🔰 "Pro-tip" 🔰 to work around this is explained at the bottom of this page

Mandatory base repos 🔴

Main repos

Compile each of these, one after the other:

• BHoM
• BHoM_Engine
• BHoM_Adapter
• BHoM_UI

User interface(s)

Compile one or more of the following - depending on the User interface software you want to use:

1. Rhinoceros_Toolkit and then Grasshopper_Toolkit (requires Rhinoceros_Toolkit)
2. Excel_Toolkit
3. Dynamo_Toolkit

The following repos are optional.

Optional base repos 🔵

These repos are sometimes used as stand-alone, and sometimes are also referenced by other repos.

You might find them useful 🚀

• BHoM_Datasets - makes Datasets available (some test scripts might be using them)
• Socket_Toolkit - send messages through Sockets. Some toolkits use this.
• Mongo_Toolkit - database connection. Some toolkits use this.
• Versioning_Toolkit - allows retro-compatibility of components (auto upgrade to newest version).

Toolkits 🌍

Toolkits provide the connection to other software.

Clone and build any toolkit you want to use!

Some examples:

• For Structural FEA analysis
  • Robot_Toolkit (for students, Robot offers a free version)
  • GSA_Toolkit
  • ETABS_Toolkit
  • Many others available!
• For Environmental simulation
  • IES_Toolkit
  • EnergyPlus_Toolkit
  • Many others available too!
• Others:
  • Speckle_Toolkit
  • LifeCycleAssessment_Toolkit
  • Explore https://github.com/BHoM ...

🔰 Pro tip - debugging and rebuild🔰

When developing a Toolkit, in order to reduce rebuild iterations, you might want to:

1. Rebuild your Toolkit
2. Rebuild BHoM_UI
3. Start Debugging your Toolkit with an UI application attached.

The last step will fire up your UI application and you will be able to modify the code while debugging, on-the-fly (just press the Pause button in Visual Studio).

Note that not all IDEs support this (notably, not the Express editions of Visual Studio – only the Community, Professional and Enterprise ones do).

An alternative that always works is, after steps 1 and 2 above, simply fire up your UI application and attach to its process. This way you will be able to follow code execution and check exceptions; however, this does not allow for code modification while debugging.

FAQ - common issues

I can't Rebuild the solution: NuGet package(s) missing error

Sometimes you might encounter this error. Although Visual Studio "Rebuild All" command should take care of Restoring the NuGet packages for you, to solve this just run that manually.

Right click the solution → Restore NuGet Packages.