Metadata-Version: 2.4
Name: seqeyes
Version: 0.0.5
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
- Windows:
  - Download the compiled `.exe` from [github releases](https://github.com/xingwangyong/seqeyes/releases)
  - Install with `pip install seqeyes`.
- Linux: Download the AppImage from [github releases](https://github.com/xingwangyong/seqeyes/releases).
- macOS: Install with `pip install seqeyes`.

## 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
Please see [build.md](build.md) for detailed build steps.

## Known Issues

Please see [KNOWN_ISSUES.md](KNOWN_ISSUES.md) for a list of known issues and limitations.



