Skip to content

merQlab/geqie

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

101 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

optiq-geqie

image

Table of contents

Related documentation:

Description

geqie_diagram

Installation

While in geqie directory invoke:

pip install .

Examples

Notebooks

See the optiq-geqie/examples directory for iPython notebooks.

CLI usage

Command geqie list-encodings

geqie list-encodings

Command geqie encode

Usage: geqie encode [OPTIONS]

Custom encoding plugins:
  [all forbidden if --encoding is set, otherwise all required]
  --init TEXT
  --data TEXT
  --map TEXT

Other options:
  --encoding TEXT      Name of the encoding from 'encodings' directory
  --image-path TEXT    Path to the image file  [required]
  -v, --verbose        Increase verbosity (can be used multiple times, up to
                       '-vvv')
  --help               Show this message and exit.

Example

geqie encode --encoding frqi --image-path assets/test_image.png

Command geqie simulate

Usage: geqie simulate [OPTIONS]

Custom encoding plugins:
  [all forbidden if --encoding is set, otherwise all required]
  --init TEXT
  --data TEXT
  --map TEXT

Other options:
  --encoding TEXT                 Name of the encoding from 'encodings'
                                  directory
  --image-path TEXT               Path to the image file  [required]
  -v, --verbose                   Increase verbosity (can be used multiple
                                  times, up to '-vvv')
  --n-shots INTEGER               Number of simulation shots
  --return-qiskit-result BOOLEAN  Return results directly from qiskit  [default:
                                  False]
  --return-padded-counts BOOLEAN  Return state counts including zero-count
                                  states  [default: False]
  --help                          Show this message and exit.

Example

geqie simulate --encoding frqi --image-path assets/test_image.png --n-shots 1024 --return-padded-counts true

Playground (GUI)

Public GUI access: https://web-staging-eb84.up.railway.app (Pending deployment on the university infrastructure).

geqie_gui_gif

See the gui/README.md for instructions on running the GEQIE GUI locally.

Related research

Citation

If you use this code in your research, please cite the main paper:

GEQIE Framework for Rapid Quantum Image Encoding at https://arxiv.org/abs/2512.24973

Acknowledgements

The authors would like to acknowledge that this repository is maintained for the OptiQ project. This Project has received funding from the European Union’s Horizon Europe programme under the grant agreement No 101080374-OptiQ. Supplementarily, the Project is co-financed from the resources of the Polish Ministry of Science and Higher Education in a frame of programme International Co-financed Projects. Disclaimer Funded by the European Union. Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or the European Research Executive Agency (REA–granting authority). Neither the European Union nor the granting authority can beheld responsible for them.

About

⚛️🖼 General Equation of Quantum Image Encoding (GEQIE) Framework

Topics

Resources

License

Stars

Watchers

Forks

Contributors