Skip to content
Eduardo Pignatelli edited this page Feb 8, 2019 · 16 revisions

Installing BHoM

We recommend using the BHoM Installer for most typical situations. Grab one of the versions below and you're on your way.

Contributors, as well as those who need a special version of a toolkit, may need to compile the source code themselves. If this is you, follow the instructions below:

Building BHoM from Source

  1. Install Visual Studio Community Edition (for help with Visual Studio, see Using Visual Studio))
  2. Install Github Desktop
  3. Using Github, clone the following repositories:
    • All of the following repos:
      • BHoM
      • BHoM_Engine
      • BHoM_Adapter
      • BHoM_UI
    • Any or all of the Toolkits, based on your needs.
    • At least one of the UIs below:
      • Dynamo_Toolkit
      • Grasshopper_Toolkit
      • Excel_Toolkit
  4. Using Visual Studio, build the projects in the order listed above. The reference Using Visual Studio has some useful tips on resolving compile errors.

Building BHoM using the Code Assistant

The Code Assistant is an alternative way to compile your code from source. You will still need Git and Visual Studio installed but it will take most of the manual processes out of the way by processing all your repositories in one click. At the moment, it is capable of performing 3 main actions using the buttons on the top right side:

  • Check Status: Update the current active branch and status of each repo (see image below for possible statuses).
  • Update Code: Pull the new commits that are not on your local copy. If a repo has been selected (tick box next to its name) but is not on your local machine yet, it will be cloned automatically.
  • Compile code: Compiles all repo in an order that respects their dependencies. It will also copy the necessary files across for things like UI plugins.

You can also switch between branches by using the combo box next to a repo name.

image

The first time you open the code assistant, you will have to provide the path to the folder where you store all your GitHub repos. Simply paste the path into the input box at the bottom and click "Save folder". Restart the app and you should be good to go.

❗ A link to the Code Assistant installer will be coming soon ... ❗

Clone this wiki locally