.. _python_package:

Reference Python Package
========================

A python package is included to help users getting started with windPRO SCRIPTING.
This consists of the main class ``WindProApi`` that lets you start windPRO and interact with its services.
Some additional functions are included that makes working with python and this underlying library easier.
For example to get an easily interpretable layer structure (``get_layer_dict``) or compare objects to find which properties are different (``compare_objects``).
These functions are provided for convenience but might not handle all possible inputs correctly.

The underlying zeep python library cannot handle ``None`` values.
Those need to be replaced with a library specific object.
This is done with ``nan_to_skipvalue`` and needs to be applied to objects that contain ``None`` values before setting with scripting.

Find below the documentation for the functionality provided in the python package
:download:`windproapi-4.0-py3-none-any.whl <./_static/python_package/windproapi-4.0-py3-none-any.whl>`.

.. automodule:: windproapi.windproapi
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: windproapi.utils
   :members:
   :undoc-members:
   :show-inheritance: