seqeyes 0.0.4__py3-none-win_amd64.whl

seqeyes/__init__.py

@@ -0,0 +1,5 @@
+"""SeqEyes Python package – Pulseq sequence viewer."""
+
+from .viewer import seqeyes
+
+__all__ = ["seqeyes"]

seqeyes/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.0.4'
+__version_tuple__ = version_tuple = (0, 0, 4)
+
+__commit_id__ = commit_id = 'gc97e3fcb2'

seqeyes/viewer.py

@@ -0,0 +1,120 @@
+"""Launch the SeqEyes GUI viewer from Python."""
+
+from __future__ import annotations
+
+import os
+import shutil
+import subprocess
+import sys
+import tempfile
+from pathlib import Path
+
+_exe_name = "seqeyes.exe" if sys.platform == "win32" else "seqeyes"
+# Bundled binary installed by the Python wheel alongside this module.
+_BUNDLED_EXE = Path(__file__).parent / "bin" / _exe_name
+
+
+def _find_executable() -> str:
+    """Return the path to the seqeyes executable.
+
+    Checks (in order):
+    1. Bundled binary shipped inside this Python package (``seqeyes/bin/``).
+    2. ``seqeyes`` on the system ``PATH``.
+    """
+    if _BUNDLED_EXE.is_file():
+        return str(_BUNDLED_EXE)
+
+    exe = shutil.which("seqeyes")
+    if exe is None:
+        raise FileNotFoundError(
+            "SeqEyes executable not found. "
+            "Install a binary wheel via 'pip install seqeyes', "
+            "or add seqeyes to your PATH."
+        )
+    return exe
+
+
+def seqeyes(*args) -> None:
+    """Launch the SeqEyes GUI viewer.
+
+    Mirrors the MATLAB ``seqeyes()`` wrapper.  All preceding positional
+    arguments are passed as command-line options; the last positional
+    argument is the sequence source.
+
+    Parameters
+    ----------
+    *args :
+        Options followed by a sequence source.  The source may be:
+
+        - a ``str`` or :class:`os.PathLike` path to a ``.seq`` file,
+        - an object with a ``write(filepath)`` method (e.g. a
+          `pypulseq <https://github.com/imr-framework/pypulseq>`_ sequence
+          object), or
+        - an option string starting with ``-`` (options-only call, e.g.
+          ``seqeyes.seqeyes('--help')``).
+
+        If called with no arguments the SeqEyes GUI opens with no file loaded.
+
+    Examples
+    --------
+    Open a ``.seq`` file:
+
+    >>> import seqeyes
+    >>> seqeyes.seqeyes('path/to/sequence.seq')
+
+    Open a pypulseq in-memory sequence:
+
+    >>> seqeyes.seqeyes(seq)
+
+    Pass extra CLI options before the source:
+
+    >>> seqeyes.seqeyes('--layout', '212', 'path/to/sequence.seq')
+
+    Raises
+    ------
+    FileNotFoundError
+        If the ``seqeyes`` executable cannot be found on ``PATH``.
+    FileNotFoundError
+        If a ``.seq`` filepath is given but the file does not exist.
+    TypeError
+        If the last argument is not a recognised sequence source.
+    """
+    exe = _find_executable()
+    cmd = [exe]
+
+    if not args:
+        # No-argument call: open GUI with no file loaded
+        subprocess.Popen(cmd)
+        return
+
+    last = args[-1]
+    options = list(args[:-1])
+    seq_fn = None
+    _tmp_path = None  # keep tempfile path for reference (delete=False)
+
+    if isinstance(last, str) and last.startswith("-"):
+        # Options-only call (e.g. '--help')
+        options = list(args)
+        last = None
+    elif isinstance(last, (str, os.PathLike)):
+        seq_fn = os.fspath(last)
+        if not os.path.isfile(seq_fn):
+            raise FileNotFoundError(f"Seq file not found: {seq_fn}")
+    elif hasattr(last, "write"):
+        # Sequence object (e.g. pypulseq.Sequence) – write to a temp file
+        tmp = tempfile.NamedTemporaryFile(suffix=".seq", delete=False)
+        tmp.close()
+        _tmp_path = tmp.name
+        seq_fn = _tmp_path
+        last.write(seq_fn)
+    else:
+        raise TypeError(
+            "Last argument must be a .seq filepath, a sequence object with a "
+            f"write() method, or an option string. Got: {type(last)!r}"
+        )
+
+    cmd.extend(options)
+    if seq_fn:
+        cmd.append(seq_fn)
+
+    subprocess.Popen(cmd)

seqeyes-0.0.4.dist-info/METADATA

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: seqeyes
+Version: 0.0.4
+Summary: Python wrapper for the SeqEyes Pulseq sequence viewer
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+# SeqEyes
+Display Pulseq sequence diagram and k-space trajectory, modified from [PulseqViewer](https://github.com/xpjiang/PulseqViewer)
+
+A brief overview of SeqEyes can be found at the  [2026 pulseq virtual meeting](https://github.com/pulseq/ISMRM-Virtual-Meeting--February-24-26-2026/blob/main/slides/day2_Seqeyes_sequence_and_trajectory_viewer_tool.pdf).
+
+![image](./doc/ui.png)
+
+## Install
+Download the compiled windows exe from [github releases](https://github.com/xingwangyong/seqeyes/releases), or from [artifacts in github actions](https://github.com/xingwangyong/seqeyes/actions). The latter is more frequently updated.
+
+## Usage
+- Open GUI, load .seq file
+- Use the command line interface 
+```bash
+seqeyes filename.seq
+```
+for more options, see `seqeyes --help`
+- Use the matlab wrapper `seqeyes.m`
+```matlab
+seqeyes('path/to/sequence.seq');
+```
+or
+```matlab
+seqeyes(seq);
+```
+- Use the python wrapper, install with `pip install seqeyes` and then:
+```python
+import seqeyes
+seqeyes.seqeyes('path/to/sequence.seq')
+```
+or
+```python
+seqeyes.seqeyes(seq)
+```
+
+## Build Instructions
+Qt6 libraries and cmake are required to build the project.
+### Linux
+Use the build.sh script to build the project.
+### Windows
+```
+cmake -S . -B out/build/x64-Release
+cmake --build out/build/x64-Release --config Release
+```
+After compilation, run the following command to deploy Qt libraries:
+```bash
+C:\Qt\6.5.3\msvc2019_64\bin\windeployqt.exe .\seqeyes.exe
+```
+
+**Note**: Please use the full path to run windeployqt.exe, as the system may have multiple versions of Qt installed.
+
+## Known Issues
+
+Please see [KNOWN_ISSUES.md](KNOWN_ISSUES.md) for a list of known issues and limitations.
+
+
+
+
+
+
+

seqeyes-0.0.4.dist-info/RECORD

@@ -0,0 +1,17 @@
+seqeyes/__init__.py,sha256=mW_HaUrT8x3kQt6aVLJ3ufHLy2GUFYHBlVwJvn8-4l8,114
+seqeyes/_version.py,sha256=Q-n6YkX67p4f-dqAuPqtFTK23GUZ_uVAoQBI6b5zZ0Y,746
+seqeyes/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+seqeyes/viewer.py,sha256=pqh_mzimr6onvqZO_MNyafGM4GEepQ9_dqlbClZ_C4g,3660
+seqeyes/bin/Qt6Core.dll,sha256=aXAm_ytILfFpeUvXsXpB-0fYelGHMFiMZoBF4fIaU9o,5793424
+seqeyes/bin/Qt6Gui.dll,sha256=i1aFRnCILL8UI5Kf_mTyI1fOJBTs_opr8EHvqKJAi9E,8071824
+seqeyes/bin/Qt6Network.dll,sha256=CwM7sE3UBSD67H2eS0Wg56WNksMCrx1QhptLrviN6nU,1373328
+seqeyes/bin/Qt6Svg.dll,sha256=mDSqLPU771dLUN1Zeyg9jYOraCVkaBHOb-mjFA0n3W8,364688
+seqeyes/bin/Qt6Widgets.dll,sha256=3c4mKU6q3UMLnyXy6qN6IVXplHiCOCzD7RSPolMixSo,6026384
+seqeyes/bin/seqeyes.exe,sha256=Ad1V1K0WoJe5zg9MA1W45DXfJ-5bryfvndyP28JvkSU,1335808
+seqeyes/bin/vc_redist.x64.exe,sha256=zA_w6x3D9RiK5jAPrvMr9b7rpL3W6ORFqRhAcglrcTs,25635768
+seqeyes-0.0.4.dist-info/licenses/LICENSE,sha256=xBMh8RQt7ZZn6mlMNPKcfY8lBS3EWAA8BSpWcgMcDcA,1559
+tests/test_viewer.py,sha256=ZxTwW4rm26cgc-Y-ts-VDVnCcnw8QQJcT4gm0iX7vPU,5897
+seqeyes-0.0.4.dist-info/METADATA,sha256=yTKaLyYcP878xIRnWGCISrdasRXBy2H9TTTdR_3hUrI,2037
+seqeyes-0.0.4.dist-info/WHEEL,sha256=QR8DNjG6Lr6bNErJWJgF4dP2dJ2N7NpY-BWly1OvcTM,97
+seqeyes-0.0.4.dist-info/top_level.txt,sha256=BbsG2JoD0T4sWHA6tywWaGZvnpII5pA1Lp5iI1kl3X8,14
+seqeyes-0.0.4.dist-info/RECORD,,

seqeyes-0.0.4.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-win_amd64
+

seqeyes-0.0.4.dist-info/licenses/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Zheng Liu
+Copyright (c) 2025, Xingwang Yong
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

seqeyes-0.0.4.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+seqeyes
+tests

tests/test_viewer.py

@@ -0,0 +1,164 @@
+"""Tests for seqeyes.seqeyes() viewer launcher."""
+
+import os
+import pytest
+from unittest.mock import patch, MagicMock
+
+
+# ---------------------------------------------------------------------------
+# Helpers
+# ---------------------------------------------------------------------------
+
+FAKE_EXE = "/usr/local/bin/seqeyes"
+
+
+def _popen_mock():
+    """Return a mock that replaces subprocess.Popen."""
+    return MagicMock()
+
+
+# ---------------------------------------------------------------------------
+# Executable discovery
+# ---------------------------------------------------------------------------
+
+def test_seqeyes_raises_when_exe_not_found():
+    """FileNotFoundError when neither bundled binary nor PATH entry exists."""
+    from seqeyes.viewer import seqeyes
+    with patch("shutil.which", return_value=None), \
+         patch("pathlib.Path.is_file", return_value=False):
+        with pytest.raises(FileNotFoundError, match="executable not found"):
+            seqeyes("dummy.seq")
+
+
+def test_find_executable_prefers_bundled(tmp_path):
+    """_find_executable returns the bundled binary when it exists."""
+    import sys
+    from seqeyes import viewer
+    from seqeyes.viewer import _find_executable
+
+    _exe_name = "seqeyes.exe" if sys.platform == "win32" else "seqeyes"
+    fake_bin = tmp_path / _exe_name
+    fake_bin.touch()
+
+    with patch.object(viewer, "_BUNDLED_EXE", fake_bin):
+        result = _find_executable()
+
+    assert result == str(fake_bin)
+
+
+# ---------------------------------------------------------------------------
+# No-argument call
+# ---------------------------------------------------------------------------
+
+def test_seqeyes_no_args_opens_gui(tmp_path):
+    """Calling seqeyes() with no args should Popen the bare executable."""
+    from seqeyes.viewer import seqeyes
+    popen = _popen_mock()
+    with patch("shutil.which", return_value=FAKE_EXE), \
+         patch("subprocess.Popen", popen):
+        seqeyes()
+    popen.assert_called_once_with([FAKE_EXE])
+
+
+# ---------------------------------------------------------------------------
+# File path argument
+# ---------------------------------------------------------------------------
+
+def test_seqeyes_filepath(tmp_path):
+    """seqeyes('file.seq') should Popen [exe, filepath]."""
+    from seqeyes.viewer import seqeyes
+    seq_file = tmp_path / "test.seq"
+    seq_file.write_text("[VERSION]\nmajor 1\nminor 4\n")
+
+    popen = _popen_mock()
+    with patch("shutil.which", return_value=FAKE_EXE), \
+         patch("subprocess.Popen", popen):
+        seqeyes(str(seq_file))
+    popen.assert_called_once_with([FAKE_EXE, str(seq_file)])
+
+
+def test_seqeyes_filepath_not_found(tmp_path):
+    """seqeyes() should raise FileNotFoundError for a missing .seq file."""
+    from seqeyes.viewer import seqeyes
+    with patch("shutil.which", return_value=FAKE_EXE):
+        with pytest.raises(FileNotFoundError, match="not found"):
+            seqeyes(str(tmp_path / "missing.seq"))
+
+
+def test_seqeyes_pathlike(tmp_path):
+    """seqeyes() should accept a pathlib.Path."""
+    from seqeyes.viewer import seqeyes
+    seq_file = tmp_path / "test.seq"
+    seq_file.write_text("[VERSION]\nmajor 1\nminor 4\n")
+
+    popen = _popen_mock()
+    with patch("shutil.which", return_value=FAKE_EXE), \
+         patch("subprocess.Popen", popen):
+        seqeyes(seq_file)
+    popen.assert_called_once_with([FAKE_EXE, str(seq_file)])
+
+
+# ---------------------------------------------------------------------------
+# Sequence object argument
+# ---------------------------------------------------------------------------
+
+def test_seqeyes_sequence_object(tmp_path):
+    """seqeyes(seq) should write to a temp file and Popen [exe, tempfile]."""
+    from seqeyes.viewer import seqeyes
+
+    written_paths = []
+
+    class FakeSeq:
+        def write(self, path):
+            written_paths.append(path)
+
+    popen = _popen_mock()
+    with patch("shutil.which", return_value=FAKE_EXE), \
+         patch("subprocess.Popen", popen):
+        seqeyes(FakeSeq())
+
+    assert len(written_paths) == 1
+    assert written_paths[0].endswith(".seq")
+    popen.assert_called_once()
+    call_args = popen.call_args[0][0]
+    assert call_args[0] == FAKE_EXE
+    assert call_args[-1] == written_paths[0]
+
+
+# ---------------------------------------------------------------------------
+# Options-only call
+# ---------------------------------------------------------------------------
+
+def test_seqeyes_help_option():
+    """seqeyes('--help') should pass --help to the executable."""
+    from seqeyes.viewer import seqeyes
+    popen = _popen_mock()
+    with patch("shutil.which", return_value=FAKE_EXE), \
+         patch("subprocess.Popen", popen):
+        seqeyes("--help")
+    popen.assert_called_once_with([FAKE_EXE, "--help"])
+
+
+def test_seqeyes_options_before_file(tmp_path):
+    """seqeyes('--layout', '212', 'file.seq') passes options before filepath."""
+    from seqeyes.viewer import seqeyes
+    seq_file = tmp_path / "test.seq"
+    seq_file.write_text("[VERSION]\nmajor 1\nminor 4\n")
+
+    popen = _popen_mock()
+    with patch("shutil.which", return_value=FAKE_EXE), \
+         patch("subprocess.Popen", popen):
+        seqeyes("--layout", "212", str(seq_file))
+    popen.assert_called_once_with([FAKE_EXE, "--layout", "212", str(seq_file)])
+
+
+# ---------------------------------------------------------------------------
+# Bad argument
+# ---------------------------------------------------------------------------
+
+def test_seqeyes_bad_last_arg():
+    """seqeyes() should raise TypeError for an unrecognised last argument."""
+    from seqeyes.viewer import seqeyes
+    with patch("shutil.which", return_value=FAKE_EXE):
+        with pytest.raises(TypeError):
+            seqeyes(42)