# Change Log

All notable changes to npeval will be documented in this file.

## 2024.003

### Added

-   Sections "Getting started" and "Stops/colors" in documentation supporting an
    efficient setup.
-   The debug output contains more details why a station is not considered
    during startup.
-   Argument descriptions and links to command-line documentation.

## 2023.352

### Added

-   The new type "MDD" for computing minimum magnitudes allows predicting the
    magnitude values a network can detect based on parameters derived from a
    catalog of known events. Earth model parameters are not required for this
    type.

## 2023.325

### Changed

-   Remove support for SeisComP3 C++ API since no packages will be provided
    for SeisComP3 anymore.

## 2023.298

### Added

-   Provide example scripts in @DATADIR@/npeval/tools for handling reports
    and generating station lists.
-   Allow configuration of files with SeisComP variables, such as @DATADIR@.
-   Sections "Getting started" and "Stops/colors" in documentation supporting
    an efficient setup.
-   The debug output contains more details why a station is not considered
    during startup.

### Changed

-   Allow generating reports without computing any value.
-   Correct comma-separation in JSON output.

## 2023.221

### Added

-   The command-line option `--suggest-color-intervals` allows setting the
    number of contour levels which are printed along with color suggestion
    as part of the debug logging output.

### Fixed

-   Use the last configured stop to fill PNG images with values beyond this
    stop in PNG images. Consider the stop also in BNA files. As a result,
    contour lines of PNG images and BNA files are identical.

## 2023.174

### Added

-   Added CSV output format.

## 2023.172

### Added

-   Added documentation of generic network evaluation.

## 2021-11-22

### Added

-   Allow using multiple module names for `setupName`, e.g. supporting evaluation
    of origins for which the picks where provided by multiple picker modules.

## Changed

-   Move npeval from gempa group to Processing in scconfig
-   New layout for documentation

## 2021-02-23

### Added

-   Support configuration of POIs with new method: S-P travel times differences

## 2021-02-04

### Added

-   Support minimum time computation also in offline mode
-   Support default as synonym for global in `setupName` configuration

## 2020-12-08

### Changed

-   Consider the correct parameter names in the default configuration

## 2020-12-03

### Important

-   The parameters for computing travel times are used by multiple methods. They
    have been renamed to avoid ignoring them when configuring `minimumMagnitude.*`
    parameters. Therefore, adjusting the configuration is required:

    ```conf
    times.tableType           -> travelTimes.tableType
    times.table               -> travelTimes.table
    times.elevationCorrection -> travelTimes.elevationCorrection
    ```

### Added

-   The new parameter travelTimes.velocityCorrection allows applying a dynamic
    correction of travel times based on the correction velocity and the slowness
    of the incoming ray. The slowness must be provided by the configured
    travel-time interface.

## 2020-11-19

### Added

-   Be tolerant against white spaces in station file.
-   Added configuration parameter `times.elevationCorrection` correcting for
    station elevation

### Fixed

-   The orientation of the magnitude grid has been corrected.

### Changed

-   In the default configuration of `qc.parameters` the minimum RMS is set to 10
    allowing also very quiet stations to be used.
-   Optimizing speed of minimum magnitude computation

## 2020-11-10

### Changed

-   In debug output propose unique colors for visualizing times and magnitudes
-   In debug output propose the steps for visualizing magnitudes based on the
    configuration parameter `minimumMagnitude.magStep`
-   Use double precision consequently

## 2020-09-25

### Important

-   Changed the default `minSNR` from 5 to 3.
-   Changed the default for `stations.stationCount` form 8 to 4 to better match
    with common scanloc configurations.

### Added

-   The new option output.script allows to configure a script which processes
    status and QC parameters of stations with changed status. The parameters are
    delivered to the script, e.g. for writing a file which is sent by GDS.

## 2020-09-25

### Added

-   The new command line parameter `rms` allows setting a constant RMS (nm/s).
    All other RMS values from file or waveform QC will be ignored.

### Changed

-   The documentation contains more examples or offline and message-based
    applications.

## 2019-10-29

### Added

-   All command-line parameters are included in the documentation
-   All default configuration parameters are contained in the default configuration
    file. This allows to conveniently copy the file to `$SEISCOMP_ROOT/etc` and
    to modify the configuration using editors.

## 2019-10-25

### Added

-   Added availability to default qc.parameters

## 2019-05-24

### Changed

-   Allow grid computation with a station file and without inventory and bindings
    configuration
-   Accept grids consisting of only 1 point

## 2019-05-07

### Changed

-   Changed internal grid creation to avoid unnecessary processing steps. In the
    specific case the BNA output was mirrored on the horizontal plane.

## 2018-11-23

### Fixed

-   Do not ignore gradient configuration in BNA and GRD mode.

## 2018-10-23

### Changed

-   The minimum magnitude computation mode requires waveform RMS available from
    QC messages and is therefore no longer available in offline mode.

### Fixed

-   Reading of station exclude file
-   Do not stop application, if the contour calculation returns no results in
    BNA mode.

## 2018-10-05

### Added

-   The debug output now contains the minimum and the maximum computed values which
    can be used for configuring the mapmultigrid plugin for showing GRD files on
    maps or gradient.stops for generating PNG images.

## 2018-07-06

### Added

-   New configuration parameter`qc.useDatabase` which can be used to do not load
    QC parameters from database. By default this option is
    enabled.

## 2018-05-18

### Added

-   When the QC parameters change very quickly or stations are frequently
    disabled or enabled, npeval may be very busy. To reduce the load by
    unnecessary or very frequent computation, the grid.update parameter
    is introduced providing the minimum time interval between two updates.

## 2018-03-21

### Fixed

-   Rendering of polygons crossing the international date line

## 2017-12-01

### Added

-   Only consider stations with module bindings by setupName

## 2017-09-05

### Added

-   Map layer plugin shows a legend

## 2017-08-17

### Fixed

-   Read station information from CSV file

## 2017-08-16

### Fixed

-   Ambiguous command line option --file.

## 2017-06-08

### Fixed

-   Contour rendering of the map layer plugin

## 2017-05-16

### Fixed

-   Add configuration parameter

## 2017-05-10

### Changed

-   Use non filled contour algorithm in BNA mode

## 2017-05-03

### Fixed

-   Handling of notifier messages

## 2017-04-28

### Added

-   Support to cleanup output directory