# Change Log

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

## 2025.301

### Important

-   A new installation of gsm package **dlmodels** (minimum version 2025.297) 
    is required to work with this version of **dlpick**. 
-   Parameters `model` and `weights` were removed. Commands and configurations 
    need to be adjusted. Use new parameter `modelWeights` instead.
-   **New naming convention** for models is active from now on. While the simple names
    like *pn-in* stay as they are, more advanced names like *pnv-et-il-150-2* 
    get a more concise and easier-to-parse form: *pnv_15s-et_il-2*: There at most 3 groups
    separated by dashes. The first group is the model name as abbreviation with optional 
    model specifics attached with an underscore '_', the second group defines the 
    datasets the model was trained on as abbreviations, separated by underscores. 
    The third group is optional and defines the weights version. 
    Custom models can be named freely but need to start with *gn-*.

### Added

-   Parameter `modelWeights` (commandline: `model-weights`) to specify the model to use.
    Works exactly like `model` and `weights` before, you just need to concatenate them.
    E.g., `--model phasenet --weights instance` becomes `--model-weights phasenet-instance`.
-   Support for **custom models** ("Generic"). Model configs contain new parameters
    to determine what needs to be done:
    -   dims => dimension order of output (e.g., BCN => batches, channels, samples)
    -   post_proc_chain => post-processing steps, currently still undocumented
    -   description => free text string to define 
-   Binding parameters `picksReductionClusterSize` and `picksReductionSimpleInterval` to 
    control the interval where only pick is allowed to exist.

## 2025.290

### Added

-   Bindings parameter `picksReductionAlgorithm` to select "Simple" or "Cluster"
    reduction algorithm. `safeReduceMinPickCount` can now be set to 0 if one 
    only wants to use the cluster algorithm without the early publishing of 
    picks (for example, in offline mode).

## 2025.289

### Added

-   New picks cluster reduce-algorithm that can be activated using the new 
    parameter `safeReduceMinPickCount`. If not set or set to 0, the old 
    "simple reduce-algorithm" will be used to reduce picks. If you use 
    overlapping of minimum 0.5, you can set the parameter to a value between
    1 and `1/(1-overlapping-ratio)` (which is approximately the maximum
    overlapping-induced coverage of a prediction segment). A cluster has 
    the maximum length of `reducePicksInterval` seconds. If a cluster
    has at least `safeReduceMinPickCount` of picks, they will be reduced
    to their most confident one, and this one is published. 
    Later picks within the interval limits around the chosen pick
    will be ignored. This is supposed to speed up realtime picking.

## 2025.261

### Changed

-   When amplitudes cannot be calculated, their value will be -1.
-   Add waveform ID to Amplitude object

### Fixed

-   The time window of the Amplitude object is now in seconds and signed

## 2025.259

### Added

-   EventParameters now contain amplitudes, calculated by maximum of the signal /
    standard deviation of the noise. Currently, amplitudes for picks too close to the border
    their prediction window can't be calculated and get amplitude 0.
-   Component letters '1' and '2' of stream IDs are now mapped to components 'N' and 'E'.
-   "DLog", which is dlpick's own logger, now writes to the log file, following the SeisComP 
    conventions. 
    All dlpick's 'DLog' messages are printed as Seiscomp warning.

### Fixed

-   Increasing the log level using verbosity flags ("-v...") now works properly for 
    dlpick's own logger.

## 2025.244

### Fixed

-   `dlpick --print-models` didn't find dlmodels_maps.json when data dir was 
    different from default. 

### Changed

-   Updated documentation

## 2025.240

### Added

-   Documentation

## 2025.198

### Important

-   The deep learning models that are used by this dlpick have been removed
    from this repository. They are now part of the GSM packages `dlmodels-pick`,
    which must be installed separately.

## 2025.119

### Changed

-   Universal configuration format for all models: Change the path where models are read from to default to 
    `/home/data/dlmodels/`
-   Change model config reading behavior to be more flexible.

### Added

-   Universal configuration format for all models: Add parameter `modelsPath` to customize the path where models 
    are read from.

### Fixed

-   Add API version check to make dlpick compatible with seiscomp 17.0.0 API and below.


## 2024.221

### Added

-   Added this changelog.