.. _plugins-yield:

Yield
=====

The yield of explosions can be computed from magnitudes. The computation is provided
by the *yield* :term:`plugin`.


Station yield
-------------

The station yield values are computed from :term:`mb <magnitude, body-wave (mb)>`
station magnitudes by:

.. math::

   mb = A * log_{10}(yield) + B

where A and B can be configured in yield section of the gobal bindings configuration.

* yield unit: **kilotons** (kt)
* original magnitude: mb


Network yield
-------------

By default, the trimmed mean is calculated from the station magnitudes to form
the network yield. To stabilize the network magnitudes the smallest and the largest 12.5%
of the station yield values are are removed before calculating the network yield.


Setup
-----

Make yield computations available:

* Add the *yield* plugin to the existing plugins in the global configuration:

  .. code-block:: properties
  
     plugins = ${plugins}, yield

* Add a magnitude type profile named "yield" in the global bindings configuration
  with A and B corresponding to the multiplier A and the offset B, respectively.

  Default values are considered from :cite:t:`ringdal-1992`.

+-----------------------------+------+------+--------------------------------+-------------------+
| Reference                   | A    | B    | Geographic area                | application       |
+=============================+======+======+================================+===================+
| :cite:t:`ringdal-1992`      | 0.75 | 4.45 | North America and Central Asia | nuclear explosion |
+-----------------------------+------+------+--------------------------------+-------------------+
| :cite:t:`murphy-1981`       | 0.81 | 3.92 | Nevada Test Site (NTS)         | nuclear explosion |
+-----------------------------+------+------+--------------------------------+-------------------+

Compute yield automatically:

* For automatic computation of yield, add yield to the amplitudes in :cite:t:`scamp`
  and to the magnitudes in :cite:t:`scmag`.
* The yield should not be used to compute summary magnitudes by :cite:t:`scmag`.
  Add *yield* to
  :confval:`summaryMagnitude.blacklist` in the configuration of :program:`scmag`,
  :file:`scmag.cfg`, to ignore yield when computing the summary magnitude.