.. _license_runs:

==========================================
PyWAsP Subscriptions: How Runs are Counted
==========================================

PyWAsP subscriptions are based on a `tier system <https://www.wasp.dk/software/pywasp/pywasp-tiers>`_.
Three one-year subscriptions are available: Bronze, Silver, and Gold, priced according to the number of runs
and points-per-run it is possible to do in that year.

The number of runs is the number of times a call is made to any of the methods:
 - :meth:`pywasp.wasp.TopographyMap.get_site_effects`
 - :meth:`pywasp.wasp.TopographyMap.get_site_effects_rose`
 - :meth:`pywasp.lincom.FourierSpace.create_fourier_space`

There are other functions in PyWAsP that call these methods internally, including:
 - :func:`pywasp.wasp.generalize`
 - :func:`pywasp.wasp.downscale`
 - :func:`pywasp.wasp.generalize_and_downscale` (this calls ``get_site_effects`` twice and uses two runs)
 - :func:`pywasp.lincom.create_lut`.

The number of points in each run is the number of spatial output points requested from a function or method, i.e. NX * NY * NZ when a cuboid-shaped output object is requested.

To see how many spatial points are in a dataset used for output locations, the windkit function ``windkit.spatial.count_spatial_points`` can be used:

.. ipython:: python

    import windkit as wk

    output_locs_cuboid = wk.spatial.create_dataset(
        [0, 50, 100],
        [-100, -50, 0],
        [50, 75, 100],
        struct="cuboid",
        crs="EPSG:25832"
    )

    print(output_locs_cuboid)
    print(wk.spatial.count_spatial_points(output_locs_cuboid))


We get the same number if we convert from a "cuboid" to a "point" spatial structure

.. ipython:: python

    output_locs_pts = wk.spatial.to_point(output_locs_cuboid)
    print(output_locs_pts)
    print(wk.spatial.count_spatial_points(output_locs_pts))



Examples
--------
In order to calculate local effects on a grid 100 by 100 at 2 heights requires 100 * 100 * 2 = 20000 points.
This would be possible with the Bronze Tier subscription.

In order to calculate local effects on a grid of 150 by 150 at 3 heights requires 150 * 150 * 3 = 67500 points.
This would require the Silver Tier Subscription.

In order to calculate local effects on a grid of 300 by 300 at 4 heights requires 300 * 300 * 4 = 360000 points.
This would require the Gold Tier Subscription.

An example of a run that goes beyond the Gold Tier Subscription would be a grid with dimension 400 by 400 at 5 levels, requiring 800000 points.
In this case the run can be split into several smaller runs, thereby increasing the run count.