As an alternative to the built-in script editing user interface, the SDK enables you to automate WindFarmer from your preferred development environment (VSCode, Jupyter notebooks, PyCharm etc.), resulting in a more streamlined development process amenable to all professional software development practices.
The SDK enables you to link to and integrate WindFarmer into your existing software and tooling.
See SDK introduction in the WindFarmer online docs for more information on how to connect the SDK to WindFarmer. Alternative to those instructions, you could install a WindFarmer package as described below.
The source folder contains the windfarmer python package code. Currently this only has one function to connect to the WindFarmer python SDK. To run our python SDK examples you must build this package and install it to use it within other scripts.
- Open the file
Source\build_and_install.batand edit line 2 to be the location of theSourcefolder on your machine. - Copy-paste the contents of this file into a command prompt window (Start menu > type cmd.exe and open)
- Hit return and close cmd.exe
- Now you should have the windfarmer package installed into the wf_auto environment. You can check this worked correctly by running a simple script to test importing the package: Tests\test_windfarmer_Sdk.py