;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2024 Michal Atlas <michal_atlas+git@posteo.net>
;;; Copyright © 2024, 2025 Guillaume Le Vaillant <glv@posteo.net>
;;; Copyright © 2026 Spencer King <spencer.king@wustl.edu>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:
;;;
;;; Quantum computing and tensor operation module. For quantum mechanics
;;; select (gnu packages physics) module.
;;;
;;; Code:

(define-module (gnu packages quantum)
  #:use-module (gnu packages)
  #:use-module (gnu packages check)
  #:use-module (gnu packages lisp-check)
  #:use-module (gnu packages lisp-xyz)
  #:use-module (gnu packages machine-learning)
  #:use-module (gnu packages python-build)
  #:use-module (gnu packages python-check)
  #:use-module (gnu packages python-science)
  #:use-module (gnu packages python-xyz)
  #:use-module (guix build-system asdf)
  #:use-module (guix build-system pyproject)
  #:use-module (guix gexp)
  #:use-module (guix git-download)
  #:use-module ((guix licenses) #:prefix license:)
  #:use-module (guix packages))



(define %cirq-version "1.7.0")

(define %cirq-home-page "https://quantumai.google/cirq")

(define %cirq-license license:asl2.0)

;; Cirq source provides multiple Python packages all them share the same
;; version.
(define %cirq-source
  (origin
    (method git-fetch)
    (uri (git-reference
           (url "https://github.com/quantumlib/Cirq")
           (commit (string-append "v" %cirq-version))))
    (file-name (git-file-name "python-cirq" %cirq-version))
    (sha256
     (base32 "1bd8bsigfq9f00420bxj4snpcp4kr8x54y8kjx62a5q46diq231q"))))

(define-public python-cirq-core
  (package
    (name "python-cirq-core")
    (version %cirq-version)
    (source %cirq-source)
    (build-system pyproject-build-system)
    (arguments
     (list
      #:test-flags
      ;; As seen in project's CI, the full test suite is huge.
      #~(list "--ignore=cirq/contrib")
      #:phases
      #~(modify-phases %standard-phases
          (add-after 'unpack 'chdir
            (lambda _
              (chdir "cirq-core")))
          (add-before 'sanity-check 'pre-check
            (lambda _
              (setenv "HOME" "/tmp")
              (setenv "NUMBA_CACHE_DIR" "/tmp"))))))
    (native-inputs
     (list python-freezegun
           python-ipython
           python-ply
           python-pylatex
           python-pytest
           python-pytest-benchmark
           python-setuptools))
    (propagated-inputs
     (list python-attrs
           python-duet
           python-matplotlib
           python-networkx
           python-numpy
           python-pandas
           python-quimb
           python-scipy
           python-scikit-learn
           python-sortedcontainers
           python-sympy
           python-tqdm))
    (home-page %cirq-home-page)
    (synopsis "Framework for creating, editing, and running NISQ circuits.")
    (description
     "This package provides a Python framework for creating, editing, and
running Noisy Intermediate-Scale Quantum (NISQ) circuits.  Built-in simulators
are provided for running quantum algorithms.  Algorithms can also be run on a
variety of commercial quantum computing platforms by installing additional
integrations.")
    (license %cirq-license)))

(define-public python-quimb
  (package
    (name "python-quimb")
    (version "1.14.0")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
              (url "https://github.com/jcmgray/quimb")
              (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "13h57cq183nb73j83jc2lrlcyy4km3d297arbps17wawq04wwyiv"))))
    (build-system pyproject-build-system)
    (arguments
     (list
      ;; tests: 4300 passed, 508 skipped, 85 warnings
      #:test-flags
      ;; See: <https://github.com/jcmgray/quimb/issues/354>.
      #~(list "--ignore=tests/test_tensor/test_tn1d/test_compress.py")
      #:phases
      #~(modify-phases %standard-phases
          ;; QUIMB_NUM_THREAD_WORKERS is read from the environment and
          ;; must be set otherwise some tests will fail since a default
          ;; value is not provided in all cases.
          (add-before 'check 'set-env
            (lambda _
              (setenv "QUIMB_NUM_THREAD_WORKERS" "1"))))))
    (native-inputs
     (list python-hatch-vcs
           python-hatchling
           python-pytest))
    (propagated-inputs
     (list python-autoray
           python-cotengra
           python-cytoolz
           python-numba
           python-numpy
           python-psutil
           python-scipy
           python-tqdm))
    (home-page "https://quimb.readthedocs.io")
    (synopsis "Library for quantum information and many-body calculations")
    (description
     "This package provides a fast Python libray for performing quantum
information and many-body calculations, focusing primarily on tensor
networks.")
    (license license:asl2.0)))

(define-public sbcl-rpcq
  (package
    (name "sbcl-rpcq")
    (version "3.10.0")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
              (url "https://github.com/rigetti/rpcq")
              (commit (string-append "v" version))))
       (file-name (git-file-name "cl-rpcq" version))
       (sha256
        (base32 "1bvppxlacvp0pfdbpn7ls1zxd127jacl225ds7lph5s8f8cyvf17"))))
    (build-system asdf-build-system/sbcl)
    (arguments
     (list
      ;; TODO: https://github.com/rigetti/rpcq/issues/161
      #:tests? #f))
    (native-inputs (list sbcl-fiasco))
    (inputs
     (list sbcl-alexandria
           sbcl-bordeaux-threads
           sbcl-cl-messagepack
           sbcl-cl-ppcre
           sbcl-cl-syslog
           sbcl-flexi-streams
           sbcl-local-time
           sbcl-parse-float
           sbcl-pzmq
           sbcl-trivial-backtrace
           sbcl-uuid
           sbcl-yason))
    (synopsis "RPC framework for Rigetti Quantum Cloud Services")
    (description
     "This package provides the asynchronous RPC client-server framework and
message specification for Rigetti Quantum Cloud Services (QCS).  It implements
an efficient transport protocol by using ZeroMQ (ZMQ) sockets and MessagePack
(msgpack) serialization.")
    (home-page "https://github.com/rigetti/rpcq")
    (license license:asl2.0)))

(define-public cl-rpcq
  (sbcl-package->cl-source-package sbcl-rpcq))

(define-public sbcl-cl-quil
  (package
    (name "sbcl-cl-quil")
    (version "1.26.0")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/quil-lang/quilc")
             (commit (string-append "v" version))))
       (file-name (git-file-name "cl-quil" version))
       (sha256
        (base32 "1s99lk456sw9hhsx5cf3x9r97iw9s3ydqsd94zz3bjnq77wmkhz5"))))
    (build-system asdf-build-system/sbcl)
    (arguments
     (list
      ;; Requires cyclic dependency with qvm
      #:tests? #f))
    (inputs
     (list sbcl-abstract-classes
           sbcl-alexa
           sbcl-alexandria
           sbcl-cl-algebraic-data-type
           sbcl-cl-grnm
           sbcl-cl-heap
           sbcl-cl-permutation
           sbcl-cl-yacc
           sbcl-global-vars
           sbcl-magicl
           sbcl-optima
           sbcl-parse-float
           sbcl-queues
           sbcl-salza2
           sbcl-split-sequence
           sbcl-trivial-garbage
           sbcl-yason))
    (synopsis "The optimizing Quil compiler")
    (description
     "Quil is the quantum instruction language, originally developed at
Rigetti Computing.  In Quil quantum algorithms are expressed using Quil's
standard gates and instructions")
    (home-page "https://github.com/quil-lang/quilc")
    (license license:asl2.0)))

(define-public cl-quil
  (sbcl-package->cl-source-package sbcl-cl-quil))

(define-public sbcl-qvm
  (package
    (name "sbcl-qvm")
    (version "1.17.2")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/quil-lang/qvm")
             (commit (string-append "v" version))))
       (file-name (git-file-name "cl-qvm" version))
       (sha256
        (base32 "1cvmkqfcy7rv5jlim4kh4dvqhd3jk6mw1kwrphaqghjymrf72yp8"))))
    (build-system asdf-build-system/sbcl)
    (outputs '("out" "bin"))
    (inputs
     (list sbcl-abstract-classes
           sbcl-alexandria
           sbcl-cffi
           sbcl-cl-quil
           sbcl-global-vars
           sbcl-ieee-floats
           sbcl-lparallel
           sbcl-magicl
           sbcl-mt19937
           sbcl-static-vectors
           sbcl-trivial-features
           sbcl-trivial-garbage

           ;; qvm-app
           sbcl-cl-syslog
           sbcl-command-line-arguments
           sbcl-hunchentoot
           sbcl-slime-swank
           sbcl-trivial-benchmark))
    (arguments
     (list
      #:asd-systems ''("qvm" "qvm-app")
      #:tests? #f
      #:phases
      #~(modify-phases %standard-phases
          (add-after 'unpack 'remove-git-dependency
            (lambda _
              (substitute* "app/src/qvm-app-version.lisp"
                (("\\(git-hash '#:qvm-app\\)")
                 "\"unknown\""))))
          (add-after 'unpack 'fix-build
            (lambda _
              ;; Don't use symbol that doesn't exists in swank 2.31.
              (substitute* "app/src/entry-point.lisp"
                (("\\(defvar swank:\\*use-dedicated-output-stream\\*\\)")
                 "")
                (("\\(setf swank:\\*use-dedicated-output-stream\\* nil\\)")
                 ""))))
          (add-after 'create-asdf-configuration 'build-program
            (lambda* (#:key outputs #:allow-other-keys)
              (build-program (string-append (assoc-ref outputs "bin")
                                            "/bin/qvm")
                             outputs
                             #:dependencies '("qvm-app")
                             #:entry-program '((qvm-app::asdf-entry-point))
                             #:compress? #t))))))
    (synopsis "Quil simulator")
    (description
     "This is the official Quil-Lang Quantum Virtual Machine (QVM),
a flexible and efficient simulator for Quil.")
    (home-page "https://github.com/quil-lang/qvm")
    (license (list license:asl2.0
                   license:agpl3))))

(define-public cl-qvm
  (sbcl-package->cl-source-package sbcl-qvm))