.. _services_Calculation: 

Calculations Service
====================

CalculationService provides access to functionality related to calculations in windPRO.
The CalculationService gives access to common functionalities for all calculations, e.g. generating reports or starting the calculation.
Additionally, some calculations have specialized services to access the properties of this calculation.
For those calculation windPRO scripting offers access via specialized services.
All calculation types available via windPRO scripting are listed below:

.. list-table:: Calculation types in windPRO scripting
    :widths: 25 75 75
    :header-rows: 1

    * - Calculation type
      - Description
      - Scripting Service
    * - CalcFlow
      - Flowrequest file for export
      - not available
    * - CalcMesoPoint
      - Mesoscale data on demand
      - not available
    * - CalcMCP
      - MCP calculation
      - :ref:`CalcMCPService <calculations_mcp>`
    * - CalcMCP2005
      - MCP version 2005
      - not available
    * - CalcNoise
      - Noise calculation from DECIBEL
      - :ref:`CalcDecibelService <calculations_decibel>`
    * - CalcPark
      - PARK calculation
      - :ref:`CalcParkService <calculations_park>`
    * - CalcResource
      - RESOURCE calculation
      - :ref:`CalcResourceService <calculations_resource>`
    * - CalcShadow
      - Shadow calculation from ZVI
      - :ref:`CalcShadowService <calculations_shadow>`
    * - CalcSiteCompliance
      - Site compliance calculation
      - not available
    * - CalcStatgen
      - STATGEN wind statistic
      - :ref:`CalcStatgenService <calculations_statgen>`
    * - CalcWaspCfd
      - WAsP CFD calculation
      - not available
    * - CalcZVI
      - Visual Impact calculations
      - :ref:`CalcZVIService <calculations_zvi>`


In the following a few examples are give.
To use the service you need to call *get_service* from the WindProApi class with the service as a parameter.

.. code-block:: python

    import os
    from windproapi.utils import get_windpro_sample_path
    from windproapi import WindProApi

    _windproapi = WindProApi()
    _windproapi.start_windpro_random_port()
    calculation_service = _windproapi.get_service('CalculationService')

To get all calculation of a specific type use GetCalcs() with the calculation type as a parameter.

.. code-block:: python

    project_service = _windproapi.get_service('ProjectService')
    working_dir = os.path.join(get_windpro_sample_path("4.0"), 'New Salem\\4.0')
    project_path = os.path.join(working_dir, 'New Salem.w40p')
    project_service.LoadFromFile(project_path)

    all_park_calcs = calculation_service.GetCalcs('CalcPark')
    print(all_park_calcs)

    # Output:
    """
    {
    'Handle': 1102300,
    'Name': 'PARK: new energy concept-CFD based',
    'ModNum': 110,
    'CalcNum': 1,
    'CalcType': 'CalcPark'
    }...
    """

To create an empty calculation use ``CreateEmpty`` with the calculation as the parameter

.. code-block:: python

	Handle = calculation_service.CreateEmpty('CalcPark')

You can save calculations to files with ``SaveToFile``. It needs two parameters.
The first has to be the handle of the calculation you want to save.
The second parameter is the path with filename, where you want to save it.

.. code-block:: python
	
	Path = "C:/Calculations/FILENAME.xml"
	
	calculation_service.SaveToFile(Handle, Path)
	
If you have a calculation saved, you can create a calculation in WindPro from a file with ``CreateFromFile()``.
It takes in two parameters, the calculation type and the path to the file.

.. warning:: To ensure scripts are not interrupted pop up windows are suppressed as much as possible. If you will choose a file name that is not compatible with Windows naming restrictions the file cannot be generated but no warning or error message will appear.

.. code-block:: python
	
	Path = "C:/Calculations/FILENAME.xml"
	
	# calcFromFile will store a handle for the new calculation
	calcFromFile = calculation_service.CreateFromFile('CalcPark', Path)

You can clone a calculation with ``Clone``, this method needs the handle of the calculation you want to clone as a parameter.
This is especially useful for running many calculations with different sets of inputs, for example for sensitivity studies.
	
.. code-block:: python
	
	# ClonedCalc will store a new handle for the new calculation
	ClonedCalc = calculation_service.Clone(Handle)

Results from a calculation are only available as a result to file.
``GetResToFiles`` result to file options are that are available for that calculation.
To save a result to a file use ``ResultToFile``.
It takes in three parameters, the handle for the calculation, the calculation type, and the path where it should be saved.

.. code-block:: python

	ResToFile = calculation_service.GetResToFiles(Handle)
	calculation_service.ResultToFile(Handle, 'Park time variation', Path)

It is possible to automatically create PDF reports using scripting.
To get all available reports of a calculation use ``GetReports`` with the handle of the calculation as a parameter.
	
.. code-block:: python

	# Reports stores information of all the reports beloning to the calculation
	Reports = calculation_service.GetReports(Handle)
	print(Reports)
	# Output
	"""
	{
	'ID': '40',
	'Name': 'Scaling info',
	'IsResToFile': False
	}...
	"""

To save a report to a pdf file use ``SaveReportToPdf`` with the handle for the calculation as first parameter,
the reportID as the second parameter, and the path you want to save it to as the last parameter.

.. code-block:: python

	reportID = 24
	# SaveToPdf stores a true value if succes
	SaveToPdf = calculation_service.SaveReportAsPdf(Handle, reportID, path)

For changing a calculation with it specialized service it need to be opened.
This is equivalent to opening the calculation in windPRO but the calculation will not open in the GUI.
While a calculation is open for editing, it is not possible to to use methods ``ResultToFile`` and ``SaveReportAsPdf``.
Trying those methods will result in error messages in your script.
You should also only open one calculation at a time within scripting.

.. warning:: You can still open the same calculation from the GUI the same time as scripting. This should be avoided to prevent unexpected behaviour.

For modifying the calculation you need to load it with the respective calculation service.
Modifications are done with the respective ``Get...`` and ``Set...`` methods
The workflow on a short example code is illustrated below for the ParkService:

.. code-block:: python

    from windproapi import nan_to_skipvalue

    calc_park_service = _windproapi.get_service('CalcParkService')

    Handle = calculation_service.CreateEmpty('CalcPark')
    calculation_service.OpenCalcForEdit(Handle)
    park_calc = calc_park_service.GetParkCalc()
    park_calc.WakeModelType = "ParkWakeModelNOJensenPark2"
    nan_to_skipvalue(park_calc)
    calc_park_service.SetParkCalc(park_calc)
    calculation_service.CloseCalc(True)
    calculation_service.Calculate(Handle)

The above examples are for illustration only and do not give a runnable example without the right imports.
You will need to download the sample project New Salem from windPRO.
The example accesses some calculations, gives the meta-information, recalculates an example, and saves some reports.

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