summaryrefslogtreecommitdiff
path: root/pkgs/development/python-modules/vmas/default.nix
blob: 90812f51e90d04ddbed54bae48a30b52398fbf2b (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
{
  lib,
  buildPythonPackage,
  fetchFromGitHub,
  gym,
  gym-notices,
  gymnasium,
  matplotlib,
  moviepy,
  numpy,
  opencv4,
  pyglet,
  pytestCheckHook,
  pythonOlder,
  pyyaml,
  setuptools,
  shimmy,
  six,
  torch,
  tqdm,
}:

buildPythonPackage rec {
  pname = "vmas";
  version = "1.5.2";
  pyproject = true;

  # dependency "gym" broken
  disabled = pythonOlder "3.12";

  src = fetchFromGitHub {
    owner = "proroklab";
    repo = "VectorizedMultiAgentSimulator";
    tag = version;
    hash = "sha256-i1dr65IPIOGAH/1jXS7+PnxJzl986+fGB7M4ydisIrs=";
  };

  build-system = [ setuptools ];

  dependencies = [
    gym
    gym-notices
    numpy
    pyglet
    six
    torch
  ];

  optional-dependencies = {
    gymnasium = [
      gymnasium
      shimmy
    ];

    render = [
      matplotlib
      moviepy
      opencv4
    ];
  };

  pythonRelaxDeps = [
    "gym-notices"
    "pyglet"
  ];

  disabledTests = [
    # pyglet.display.xlib.NoSuchDisplayException: Cannot connect to "None"
    "test_use_vmas_env"
    # Missing python3Packages.cvxpylayers
    "test_heuristic"
  ];

  nativeCheckInputs = [
    pytestCheckHook
    pyyaml
    tqdm
  ]
  ++ optional-dependencies.gymnasium;

  pythonImportsCheck = [ "vmas" ];

  meta = {
    description = "A vectorized differentiable simulator designed for efficient Multi-Agent Reinforcement Learning benchmarking";
    homepage = "https://github.com/proroklab/VectorizedMultiAgentSimulator";
    license = lib.licenses.gpl3Only;
    maintainers = with lib.maintainers; [ derdennisop ];
  };
}