summaryrefslogtreecommitdiff
path: root/pkgs/development/python-modules/nifty8/default.nix
blob: 46c05bb3f2f4e278ee9f317e53d89081d0e4e6a5 (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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
{
  lib,
  stdenv,
  buildPythonPackage,
  fetchFromGitLab,

  # build-system
  setuptools,

  # dependencies
  astropy,
  ducc0,
  h5py,
  jax,
  jaxlib,
  matplotlib,
  mpi,
  mpi4py,
  numpy,
  scipy,

  # test
  pytestCheckHook,
  pytest-xdist,
  mpiCheckPhaseHook,
  openssh,
}:

buildPythonPackage rec {
  pname = "nifty8";
  version = "8.5.7";
  pyproject = true;

  src = fetchFromGitLab {
    domain = "gitlab.mpcdf.mpg.de";
    owner = "ift";
    repo = "nifty";
    tag = "v${version}";
    hash = "sha256-5KPmM1UaXnS/ZEsnyFyxvDk4Nc4m6AT5FDgmCG6U6YU=";
  };

  # nifty8.re is the jax-backed version of nifty8 (the regular one uses numpy).
  # It is not compatible with the latest jax update:
  # https://gitlab.mpcdf.mpg.de/ift/nifty/-/issues/414
  # While the issue is being fixed by upstream, we completely remove this package from the source and the tests.
  postPatch = ''
    rm -r src/re
    rm -r test/test_re
  '';

  build-system = [ setuptools ];

  dependencies = [
    astropy
    ducc0
    h5py
    jax
    jaxlib
    matplotlib
    mpi4py
    mpi
    numpy
    scipy
  ];

  nativeCheckInputs = [
    pytestCheckHook
    pytest-xdist
    mpiCheckPhaseHook
    openssh
  ];

  # Prevents 'Fatal Python error: Aborted' on darwin during checkPhase
  preCheck = lib.optionalString stdenv.hostPlatform.isDarwin ''
    export MPLBACKEND="Agg"
  '';

  disabledTests = lib.optionals stdenv.hostPlatform.isDarwin [
    # [XPASS(strict)] np.vdot inaccurate for single precision
    "test_vdot"
  ];

  __darwinAllowLocalNetworking = true;
  postCheck =
    lib.optionalString
      (
        # Fails on aarch64-linux with:
        # hwloc/linux: failed to find sysfs cpu topology directory, aborting linux discovery.
        # All nodes which are allocated for this job are already filled.
        !(stdenv.hostPlatform.isLinux && stdenv.hostPlatform.isAarch64)
      )
      ''
        ${lib.getExe' mpi "mpirun"} -n 2 --bind-to none python3 -m pytest test/test_mpi
      '';

  pythonImportsCheck = [ "nifty8" ];

  meta = {
    homepage = "https://gitlab.mpcdf.mpg.de/ift/nifty";
    changelog = "https://gitlab.mpcdf.mpg.de/ift/nifty/-/blob/v${version}/ChangeLog.md";
    description = "Bayesian Imaging library for high-dimensional posteriors";
    longDescription = ''
      NIFTy, "Numerical Information Field Theory", is a Bayesian imaging library.
      It is designed to infer the million to billion dimensional posterior
      distribution in the image space from noisy input data.  At the core of
      NIFTy lies a set of powerful Gaussian Process (GP) models and accurate
      Variational Inference (VI) algorithms.
    '';
    license = lib.licenses.gpl3;
    maintainers = with lib.maintainers; [ parras ];
  };
}