BHoM.Interop.Python 8.0.0-alpha.3.0

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
This is a prerelease version of BHoM.Interop.Python. 
dotnet add package BHoM.Interop.Python --version 8.0.0-alpha.3.0                

                    
                

            
NuGet\Install-Package BHoM.Interop.Python -Version 8.0.0-alpha.3.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="BHoM.Interop.Python" Version="8.0.0-alpha.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add BHoM.Interop.Python --version 8.0.0-alpha.3.0                

                    
                

            
#r "nuget: BHoM.Interop.Python, 8.0.0-alpha.3.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install BHoM.Interop.Python as a Cake Addin
#addin nuget:?package=BHoM.Interop.Python&version=8.0.0-alpha.3.0&prerelease

// Install BHoM.Interop.Python as a Cake Tool
#tool nuget:?package=BHoM.Interop.Python&version=8.0.0-alpha.3.0&prerelease

License: LGPL v3

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.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on BHoM.Interop.Python:

Package Downloads
BHoM.Interop.LadybugTools

Interact with Ladybug Tools via BHoM

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
8.0.0-alpha.3.0 38 11/9/2024
8.0.0-alpha.2.0 48 10/26/2024
7.3.4-alpha 66 8/24/2024
7.3.3-alpha 62 8/10/2024
6.3.4.1-alpha 180 12/4/2023
6.3.4-alpha 80 11/26/2023
6.3.3-alpha 86 11/13/2023
6.3.2.1-alpha 69 11/7/2023
6.3.1.1-alpha 86 10/24/2023

This package contains all work completed during Sprint 3 of the 8.0 milestone.