Usage

Python

Functionality of the code provided by LadybugTools_Toolkit is best accessed via Python directly. An example Jupyter notebook demonstrating some of these capabilities can be found here.

The workflow demonstrated runs an EnergyPlus surface temperature simulation, a Radiance incident annual hourly radiation simulation, calculation of effective MRT using SolarCal and then the application of a contextual shelter to give a UTCI result for the given EPW file and contextual surface material properties.

Jupyter

A Jupyter notebook is a recommended way of creating and tinkering with Python scripts.

For convenient access to the Jupyter environment, you may wish to create a batch file:

1. Create a new text file in a useful location, such as on your desktop. Call it jupyter.bat (or any file name with extension .bat).
2. Right-click the file (or shift + right-click if you're on Windows 11) and select 'Edit'.
3. Add the following text to the file. Change the path at the end to a folder on your computer where you will save your Jupyter notebooks.

cmd.exe /K C:/ProgramData/BHoM/Extensions/PythonEnvironments/Python_Toolkit/v3_10/Scripts/jupyter-lab.exe --autoreload --NotebookApp.token='' --notebook-dir "C:\any\folder\on\your\machine"

To launch Jupyter, double-click the batch file.

BHoM

The same workflow is also demonstrated in Grasshopper here using BHoM wrapped Python code to simplify access to those happiest using that interface (or any other interface in which BHoM is accessible). A list of methods that can be done this way are listed here