.. _calculations_optimize:

Optimize Calculation Service
============================

The new optimizer in windPRO is also available via scripting (the previously used optimizer is not available).
The optimizer is designed for the use in the GUI and features possibilities for parallel calculations and a handy
hierarchy for trying out different wind turbine types, resource grids, and other constraints.
This interactivity makes the interaction with scripting more complex compared to other calculation services.

The optimizer has a hierarchy structure of:

.. list-table:: Data types available from online
    :widths: 25 100
    :header-rows: 0

    * - Session
      - Overall container holding multiple sites
    * - Sites
      - Selection of wind resource and wtg area
    * - WTG
      - A wind trubine type to use
    * - Size
      - number Of turinbes allowed
    * - Layout
      - Layout realized

Each of these layers is identifiable via unique identifiers as properties called "Guid".
In principle there can be multiple layouts per size.
Sessions, sites, and wtgs can all be generated with an Add method.
Data can be accessed with a Get metho and send back to windPRO with a Set method.
Size and Layout are the exception that are generate with ``CreateDefaultLayouts`` both are the same time.
They cannot be changed again with a set method but have a get method to access the data.

Running the optimization
**************************

Compared to other calculations the optimizer can run asynchronous,
meaning you can start the optimization and and at the same time work within the optimizer.
Therefore, calculations can be started but for determining when they are done it is necessary to check their status.
Multiple optimizations can be started at the same time in windPRO.

Optimizing on LCOE and NPV
**************************

For NPV and LCOE calculation a turbine cost model needs to be defined. 
This is possible in windPRO but not fully included in the scripting interface.
At present the ID for the cost model is simply the position in the list of added cost models. 
It is possible to use this in scripting, but there is no way of validating which cost model is used or how they are set up.

The script below gives an example of automatically setting up an optimization from a prepared project.
For this project all resource files and a wtg area are already defined but they can be set up with scripting as well.

.. literalinclude:: ../../python/examples/fromDocs/optimize_service.py