summaryrefslogtreecommitdiff
path: root/pkgs/development/python-modules/pyssim/default.nix
blob: 52eaafa2349f976b8c5d2ce6a5fcc35ce89678ee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
{
  lib,
  buildPythonPackage,
  fetchFromGitHub,
  numpy,
  scipy,
  pillow,
  pywavelets,
  setuptools,
}:

buildPythonPackage rec {
  pname = "pyssim";
  version = "0.7.1";
  pyproject = true;

  # PyPI tarball doesn't contain test images so let's use GitHub
  src = fetchFromGitHub {
    owner = "jterrace";
    repo = "pyssim";
    tag = "v${version}";
    hash = "sha256-6393EATaXg12pYXPaHty+8LepUM6kgtZ0zSjZ1Izytg=";
  };

  build-system = [
    setuptools
  ];

  dependencies = [
    numpy
    scipy
    pillow
    pywavelets
  ];

  # Tests are copied from .github/workflows/python-package.yml
  checkPhase = ''
    runHook preCheck
    $out/bin/pyssim test-images/test1-1.png test-images/test1-1.png | grep 1
    $out/bin/pyssim test-images/test1-1.png test-images/test1-2.png | grep 0.998
    $out/bin/pyssim test-images/test1-1.png "test-images/*" | grep -E " 1| 0.998| 0.672| 0.648" | wc -l | grep 4
    $out/bin/pyssim --cw --width 128 --height 128 test-images/test1-1.png test-images/test1-1.png | grep 1
    $out/bin/pyssim --cw --width 128 --height 128 test-images/test3-orig.jpg test-images/test3-rot.jpg | grep 0.938
    runHook postCheck
  '';

  meta = {
    description = "Module for computing Structured Similarity Image Metric (SSIM) in Python";
    mainProgram = "pyssim";
    homepage = "https://github.com/jterrace/pyssim";
    changelog = "https://github.com/jterrace/pyssim/blob/${src.tag}/CHANGES.md";
    license = lib.licenses.mit;
    maintainers = with lib.maintainers; [ jluttine ];
  };
}