Install me

To install the Python_Toolkit:

1. Compile:
   1. BHoM
   2. BHoM_Engine
   3. BHoM_Adapter
   4. BHoM_UI
   5. Rhinoceros_Toolkit
   6. Grasshopper_Toolkit
   7. Python_Toolkit (this repo)
2. Open a UI of your choice (e.g. Grasshopper)
3. Run the BH.Engine.Python.Compute.InstallPythonToolkit component and wait for the installation to finish
4. The installation has succeeded if the install packages include:
   • Python 3.7
   • jupyterlab
   • matplotlib
   • Python_Toolkit
5. Restart your UI or recompute the script

To check whether all went well you can run the component BH.Engine.Python.Compute.Import with an input of a string as Python_Engine, and check that it succeed without errors

Installation structure

There are two main events to install the toolkit:

1. Compiling the toolkit. This does two things:
   • It builds the dynamic libraries required by .NET and copies them to C:\ProgramData\BHoM\Assemblies
   • It packs the python files in the toolkit and copies them to C:\ProgramData\BHoM\Extensions\Python\src
2. Installing the Toolkit from the UI. This is performed by running the InstallPythonToolkit method. This will:
   • Download Python and install python
   • Download and install pip
   • Install the necessary packages (e.g. jupyterlab)
   • Install the python bindings of the Python_Toolkit from C:\ProgramData\BHoM\Extensions\Python\src This contains all the code that is currently developed in the toolkit in python

Building the BHoM and the Toolkits from Source

You will need the following to build BHoM:

• Microsoft Visual Studio 2013 or higher
• Microsoft .NET Framework 4.0 and above (included with Visual Studio 2013)
• Note that there are no software - specific dependencies (only operating system relevant), this is specific: BHoM is a software agnostic object model.

Want to contribute?

BHoM is an open-source project and would be nothing without its community. Take a look at our contributing guidelines and tips here.

Licence

BHoM is free software licenced under GNU Lesser General Public Licence - https://www.gnu.org/licenses/lgpl-3.0.html
Each contributor holds copyright over their respective contributions. The project versioning (Git) records all such contribution source information. See LICENSE and COPYRIGHT_HEADER.