Transform into a module and make coherent with Ecosystem

.github/workflows/tests.yml

@@ -0,0 +1,30 @@
+name: Tests
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 2
+      matrix:
+        python-version: [3.9]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Set up tox env
+      run: |
+        pver=${{ matrix.python-version }}
+        tox_env="-epy${pver/./}"
+        echo tox_env
+        echo TOX_ENV=$tox_env >> $GITHUB_ENV
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+    - name: Test using tox envs
+      run: |
+        tox ${{ env.TOX_ENV }}

README.md

@@ -9,6 +9,18 @@ Points to remember while recreating
 
 Built using: Python, Tkinter, Qiskit
 
+### Launch
+
+To launch the app just run :
+```bash
+python quantum_glasses.py
+```
+
+To launch unittests just run :
+```bash
+tox -epy39
+```
+
 How the Visualizer looks?
 
 

quantum_glasses.py

@@ -1,299 +1,7 @@
-import tkinter
-from tkinter import LEFT, END, DISABLED, NORMAL
-import warnings
-import numpy as np
-import qiskit
-from qiskit import QuantumCircuit
-from qiskit.visualization import visualize_transition
+import fire
 
-# Ignore unnecessary warnings
-warnings.simplefilter("ignore")
+from quantum_glasses import QuantumGlasses
 
-# # Define Window
-# root = tkinter.Tk()
-# root.title('Quantum Glasses')
 
-# # set the icon
-# root.iconbitmap(default='logo.ico')
-# root.geometry('399x410')
-# root.resizable(0,0) # Blocking the resizing feature
-
-# # Define the colors and fonts
-background = '#2c94c8'
-buttons = '#834558'
-special_buttons = '#bc3454'
-button_font = ('Arial', 18)
-display_font = ('Arial', 32)
-
-# Initialize the Quantum Circuit
-def initialize_circuit():
-    global circuit
-    circuit = QuantumCircuit(1)
-
-initialize_circuit()
-
-
-theta = 0
-
-# Define Functions
-
-
-
-
-def about():
-    """
-    Displays the info about the project!
-    """
-    info = tkinter.Tk()
-    info.title('About')
-    info.geometry('650x470')
-    info.resizable(0,0)
-
-    text = tkinter.Text(info, height = 20, width = 20)
-
-    # Create label
-    label = tkinter.Label(info, text = "About Quantum Glasses:")
-    label.config(font =("Arial", 14))
-
-
-    text_to_display = """ 
-    About: Visualization tool for Single Qubit Rotation on Bloch Sphere
-
-    Created by : Jay Shah
-    Created using: Python, Tkinter, Qiskit
-
-    Info about the gate buttons and corresponding qiskit commands:
-
-    X = flips the state of qubit -                                 circuit.x()
-    Y = rotates the state vector about Y-axis -                    circuit.y()
-    Z = flips the phase by PI radians -                            circuit.z()
-    Rx = parameterized rotation about the X axis -                 circuit.rx()
-    Ry = parameterized rotation about the Y axis.                  circuit.ry()
-    Rz = parameterized rotation about the Z axis.                  circuit.rz()
-    S = rotates the state vector about Z axis by PI/2 radians -    circuit.s()
-    T = rotates the state vector about Z axis by PI/4 radians -    circuit.t()
-    Sd = rotates the state vector about Z axis by -PI/2 radians -  circuit.sdg()
-    Td = rotates the state vector about Z axis by -PI/4 radians -  circuit.tdg()
-    H = creates the state of superposition -                       circuit.h()
-
-    For Rx, Ry and Rz, 
-    theta(rotation_angle) allowed range in the app is [-2*PI,2*PI]
-
-    In case of a Visualization Error, the app closes automatically.
-    This indicates that visualization of your circuit is not possible.
-
-    At a time, only ten operations can be visualized.
-    """
-
-    label.pack()
-    text.pack(fill='both',expand=True)
-
-    # Insert the text
-    text.insert(END,text_to_display)
-
-    # run
-    info.mainloop()
-
-
-def change_theta(num,window,circuit,key):
-    """
-    CHanges the global variable theta and destroys the window
-    """
-    global theta
-    theta = num * np.pi
-    if key=='x':
-        circuit.rx(theta,0)
-        theta = 0
-    elif key=='y':
-        circuit.ry(theta,0)
-        theta = 0
-    else:
-        circuit.rz(theta,0)
-        theta = 0
-    window.destroy()
-
-def user_input(circuit,key):
-    """
-    Take the user input for rotation angle for parameterized 
-    Rotation gates Rx, Ry, Rz.
-    """
-
-    # Initialize and define the properties of window
-    get_input = tkinter.Tk()
-    get_input.title('Get Theta')
-    get_input.geometry('360x160')
-    get_input.resizable(0,0)
-
-    val1 = tkinter.Button(get_input,height=2,width=10,bg=buttons,font=("Arial",10),text='PI/4',command=lambda:change_theta(0.25,get_input,circuit,key))
-    val1.grid(row=0, column=0)
-
-    val2 = tkinter.Button(get_input,height=2,width=10,bg=buttons,font=("Arial",10),text='PI/2',command=lambda:change_theta(0.50,get_input,circuit,key))
-    val2.grid(row=0, column=1)
-
-    val3 = tkinter.Button(get_input,height=2,width=10,bg=buttons,font=("Arial",10),text='PI',command=lambda:change_theta(1.0,get_input,circuit,key))
-    val3.grid(row=0, column=2)
-
-    val4 = tkinter.Button(get_input,height=2,width=10,bg=buttons,font=("Arial",10),text='2*PI',command=lambda:change_theta(2.0,get_input,circuit,key))
-    val4.grid(row=0, column=3,sticky='W')
-
-    nval1 = tkinter.Button(get_input,height=2,width=10,bg=buttons,font=("Arial",10),text='-PI/4',command=lambda:change_theta(-0.25,get_input,circuit,key))
-    nval1.grid(row=1, column=0)
-
-    nval2 = tkinter.Button(get_input,height=2,width=10,bg=buttons,font=("Arial",10),text='-PI/2',command=lambda:change_theta(-0.50,get_input,circuit,key))
-    nval2.grid(row=1, column=1)
-
-    nval3 = tkinter.Button(get_input,height=2,width=10,bg=buttons,font=("Arial",10),text='-PI',command=lambda:change_theta(-1.0,get_input,circuit,key))
-    nval3.grid(row=1, column=2)
-
-    nval4 = tkinter.Button(get_input,height=2,width=10,bg=buttons,font=("Arial",10),text='-2*PI',command=lambda:change_theta(-2.0,get_input,circuit,key))
-    nval4.grid(row=1, column=3,sticky='W')
-
-    text_object = tkinter.Text(get_input, height = 20, width = 20,bg="light cyan")
-
-    note = """
-    GIVE THE VALUE FOR THETA
-    The value has the range [-2*PI,2*PI]
-    """
-
-    text_object.grid(sticky='WE',columnspan=4)
-    text_object.insert(END,note)
-
-
-    get_input.mainloop()
-
-# Define functions for qiskit-based buttons
-# Define the function for visualize button
-def visualize_circuit(circuit,window):
-    """
-    Visualizes the single qubit rotations corresponding to applied gates in a separate tkinter window.
-    Handles any possible visualization error
-    """
-    try:
-        visualize_transition(circuit=circuit)
-    except qiskit.visualization.exceptions.VisualizationError:
-        window.destroy()
-
-
-def main():
-    '''
-    Args: -
-    Returns:
-        True if the software is invoked correctly and opens the software automatically.
-        False if exception is occured
-    '''
-    try:
-        # Define Window
-        root = tkinter.Tk()
-        root.title('Quantum Glasses')
-
-        # set the icon
-        root.iconbitmap(default='logo.ico')
-        root.geometry('399x410')
-        root.resizable(0,0) # Blocking the resizing feature
-
-        # Define Layout
-        # Define the Frames
-        display_frame = tkinter.LabelFrame(root)
-        button_frame = tkinter.LabelFrame(root,bg='black')
-        display_frame.pack()
-        button_frame.pack(fill='both',expand=True)
-
-        # Define the Display Frame Layout
-        display = tkinter.Entry(display_frame, width=120, font=display_font, bg=background, borderwidth=2, justify=LEFT)
-        display.pack(padx=3,pady=4)
-
-        # Define functions for non-qiskit buttons
-        def display_gate(gate_input):
-            """
-            Adds a corresponding gate notation in the display to track the operations.
-            If the number of operation reach ten, all gate buttons are disabled.
-            """
-            # Insert the defined gate
-            display.insert(END,gate_input)
-
-            # Check if the number of operations has reached ten, if yes,
-            # disable all the gate buttons
-            input_gates = display.get()
-            num_gates_pressed = len(input_gates)
-            list_input_gates = list(input_gates)
-            search_word = ["R","D"]
-            count_double_valued_gates = [list_input_gates.count(i) for i in search_word]
-            num_gates_pressed-=sum(count_double_valued_gates)
-            if num_gates_pressed==10:
-                gates = [x_gate, y_gate, z_gate, Rx_gate, Ry_gate, Rz_gate, s_gate, sd_gate, t_gate, td_gate, hadamard]
-                for gate in gates:
-                    gate.config(state=DISABLED)
-
-        # Define the first row of buttons
-        x_gate = tkinter.Button(button_frame, font=button_font, bg=buttons, text='X',command=lambda:[display_gate('x'),circuit.x(0)])
-        y_gate = tkinter.Button(button_frame, font=button_font, bg=buttons, text='Y',command=lambda:[display_gate('y'),circuit.y(0)])
-        z_gate = tkinter.Button(button_frame, font=button_font, bg=buttons, text='Z',command=lambda:[display_gate('z'),circuit.z(0)])
-        x_gate.grid(row=0,column=0,ipadx=45, pady=1)
-        y_gate.grid(row=0,column=1,ipadx=45, pady=1)
-        z_gate.grid(row=0,column=2,ipadx=53, pady=1, sticky='E')
-
-        # Define the second row of buttons
-        Rx_gate = tkinter.Button(button_frame, font=button_font, bg=buttons, text='RX',command=lambda:[display_gate('Rx'),user_input(circuit,'x')])
-        Ry_gate = tkinter.Button(button_frame, font=button_font, bg=buttons, text='RY',command=lambda:[display_gate('Ry'),user_input(circuit,'y')])
-        Rz_gate = tkinter.Button(button_frame, font=button_font, bg=buttons, text='RZ',command=lambda:[display_gate('Rz'),user_input(circuit,'z')])
-        Rx_gate.grid(row=1,column=0,columnspan=1,sticky='WE', pady=1)
-        Ry_gate.grid(row=1,column=1,columnspan=1,sticky='WE', pady=1)
-        Rz_gate.grid(row=1,column=2,columnspan=1,sticky='WE', pady=1)
-
-        # Define the third row of buttons
-        s_gate = tkinter.Button(button_frame, font=button_font, bg=buttons, text='S',command=lambda:[display_gate('s'),circuit.s(0)])
-        sd_gate = tkinter.Button(button_frame, font=button_font, bg=buttons, text='SD',command=lambda:[display_gate('SD'),circuit.sdg(0)])
-        hadamard = tkinter.Button(button_frame, font=button_font, bg=buttons, text='H',command=lambda:[display_gate('H'),circuit.h(0)])
-        s_gate.grid(row=2,column=0,columnspan=1,sticky='WE', pady=1)
-        sd_gate.grid(row=2,column=1,sticky='WE', pady=1)
-        hadamard.grid(row=2, column=2, rowspan=2,sticky='WENS', pady=1)
-
-        # Define the fifth row of buttons
-        t_gate = tkinter.Button(button_frame, font=button_font, bg=buttons, text='T', command=lambda:[display_gate('t'),circuit.t(0)])
-        td_gate = tkinter.Button(button_frame, font=button_font, bg=buttons, text='TD',command=lambda:[display_gate('TD'),circuit.tdg(0)])
-        t_gate.grid(row=3,column=0,sticky='WE', pady=1)
-        td_gate.grid(row=3,column=1,sticky='WE', pady=1)
-
-        def clear(circuit):
-            """
-            Clears the display!
-            Reintializes the Quantum Circuit for fresh calculation!
-            Checks if the gate buttons are disabled, if so, enables the buttons
-            """
-            # clear the display
-            display.delete(0, END)
-
-            # reset the circuit to initial state |0> 
-            initialize_circuit()
-
-            # Checks if the buttons are disabled and if so, enables them
-            if x_gate['state']==DISABLED:
-                gates = [x_gate, y_gate, z_gate, Rx_gate, Ry_gate, Rz_gate, s_gate, sd_gate, t_gate, td_gate, hadamard]
-                for gate in gates:
-                    gate.config(state=NORMAL)
-
-        # Define the Quit and Visualize buttons
-        quit = tkinter.Button(button_frame, font=button_font, bg=special_buttons, text='Quit',command=root.destroy)
-        visualize = tkinter.Button(button_frame, font=button_font, bg=special_buttons, text='Visualize',command=lambda:visualize_circuit(circuit,root))
-        quit.grid(row=4,column=0,columnspan=2,sticky='WE',ipadx=5, pady=1)
-        visualize.grid(row=4,column=2,columnspan=1,sticky='WE',ipadx=8, pady=1)
-
-        # Define the clear button
-        clear_button = tkinter.Button(button_frame, font=button_font, bg=special_buttons, text='Clear',command=lambda:clear(circuit))
-        clear_button.grid(row=5,column=0,columnspan=3,sticky='WE')
-
-        # Define the about button
-        about_button = tkinter.Button(button_frame, font=button_font, bg=special_buttons, text='About',command=about)
-        about_button.grid(row=6,column=0,columnspan=3,sticky='WE')
-
-        # Run the main loop
-        root.mainloop()
-
-        return True
-    except Exception as e:
-        print('Exception occured: \n')
-        print(e)
-        return False
-
-if __name__=='__main__':
-    _ = main()
+if __name__ == "__main__":
+    fire.Fire(QuantumGlasses().main())

quantum_glasses/__init__.py

@@ -0,0 +1,3 @@
+"""Main module."""
+
+from .quantum_glasses import QuantumGlasses