Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

https://github.com/epiqc/ScaffCC
10 October 2025, 02:50:01 UTC
  • Code
  • Branches (10)
  • Releases (1)
  • Visits
    • Branches
    • Releases
    • HEAD
    • refs/heads/ScaffCC_OSX
    • refs/heads/master
    • refs/tags/2.2
    • refs/tags/5.0
    • refs/tags/v1.0
    • refs/tags/v1.0-beta.2
    • refs/tags/v2.0
    • refs/tags/v2.1
    • refs/tags/v3.0
    • refs/tags/v4.0
    • v3.1
  • 6bbaf7c
  • /
  • scaffold
  • /
  • flatten-qasm.py
Raw File Download
Take a new snapshot of a software origin

If the archived software origin currently browsed is not synchronized with its upstream version (for instance when new commits have been issued), you can explicitly request Software Heritage to take a new snapshot of it.

Use the form below to proceed. Once a request has been submitted and accepted, it will be processed as soon as possible. You can then check its processing state by visiting this dedicated page.
swh spinner

Processing "take a new snapshot" request ...

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
  • directory
  • revision
  • snapshot
origin badgecontent badge Iframe embedding
swh:1:cnt:42ea5204d879686fb3afad4db31b488dbda54e88
origin badgedirectory badge Iframe embedding
swh:1:dir:1ca29b4f5b183c73da0bdb57eebc15f8eca0fb0c
origin badgerevision badge
swh:1:rev:66a79944ee4cd116b27bc1a69137276885461db8
origin badgesnapshot badge
swh:1:snp:7eb50f12cf990a0030724453139e994df238639f

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
  • directory
  • revision
  • snapshot
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Tip revision: 66a79944ee4cd116b27bc1a69137276885461db8 authored by Andrew Litteken on 28 September 2021, 15:30:02 UTC
Merge pull request #49 from AndrewLitteken/master
Tip revision: 66a7994
flatten-qasm.py
import argparse
import re

def process_qasm(fname):

    qgates = ['H','X','CNOT','Y','Z','S','T','Tdag','Sdag','Rx','Ry','Rz','PrepX','PrepZ','MeasX','MeasZ','Toffoli','Fredkin']    

    qgates_1 = ['H','X','Y','Z','S','T','Tdag']
    qgates_1a = ['Sdag']
    qgates_2 = ['CNOT']
    qgates_3 = ['Toffoli','Fredkin']    
    qgates_4 = ['PrepX','PrepZ']
    qgates_5 = ['MeasX','MeasZ']
    qgates_6 = ['Rx','Ry','Rz']
    qgates_7 = ['afree']
    

    gateNames = {
        'H':'H',
        'X':'X',
        'Y':'Y',
        'Z':'Z',
        'S':'S',
        'T':'T',
        'Sdag':'Sdag',
        'Tdag':'Tdag',
        'PrepX':'PrepX', #'Px',
        'PrepZ':'PrepZ', #'Pz',
        'MeasZ':'MeasZ', #'Mz',
        'MeasX':'MeasX', #'Mx',
        'Rx':'Rx',
        'Ry':'Ry',
        'Rz':'Rz',
        'CNOT':'CNOT', #'CX',
        'Toffoli':'Tof',
        'Fredkin':'Fredkin',
        'afree':'afree'
        }
    
    pattern_qbit_decl = re.compile(r"\s*\bqbit\b\s+(?P<qbit_var>\w+)\s*\[\s*(?P<array_size>\d+)\s*\]\s*;")
    pattern_cbit_decl = re.compile(r"\s*\bcbit\b\s+(?P<qbit_var>\w+)\s*\[\s*(?P<array_size>\d+)\s*\]\s*;")

    pattern_qg = re.compile(r"\s*((\w+|\w+\[(.*?)\])\s*\=)*\s*(?P<func_name>\w+)\s*\(\s*(?P<array_size>(.*?))\s*\)\s*;")
    pattern_qbit_arg = re.compile(r"(.*?)\((.*?)\bqbit\b\s*(.*?)\)(.*?)")
    pattern_meas = re.compile(r"\s*(?P<func_ret>(\w+|\w+\[(.*?)\])\s*\=)*\s*(\bqg_MeasX|qg_MeasZ\b)\s*\(\s*(?P<array_size>(.*?))\s*\)\s*;")
    pattern_main = re.compile(r"\s*(\bvoid|module\b)\s+(\bmain|main1\b)\s*\((.*?)\)\s*(\{)*\s*")
    pattern_comment = re.compile(r"\s*//--//--(.*?)--//--//\s*")

    fout_name = re.sub('\.qasmh$','_qasm.scaffold',fname)
    fout = open(fout_name,'w')

    fout.write('#include<stdio.h>\n')

    #add instrumentation functions
    for q in qgates_1:
        instFnName = 'qg_'+q
        fstr = 'void '+instFnName+'(char* a){ printf("' +gateNames[q] +' %s\\n",a); }\n'
        fout.write(fstr)

    fout.write('\n')

    for q in qgates_1a: #Sdag = S^3
        instFnName = 'qg_'+q
        fstr = 'void '+instFnName+'(char* a){ printf("S %s\\n",a); printf("S %s\\n",a); printf("S %s\\n",a); }\n'
        fout.write(fstr)

    fout.write('\n')


    for q in qgates_2: #CNOT => CX (target,control)
        instFnName = 'qg_'+q
        fstr = 'void '+instFnName+'(char* a, char* b){ printf("'+gateNames[q]+' %s,%s\\n",a,b); }\n'
        fout.write(fstr)

    fout.write('\n')

    for q in qgates_3:
        instFnName = 'qg_'+q
        fstr = 'void '+instFnName+'(char* a, char* b, char* c){ printf("' +gateNames[q] +' %s,%s,%s\\n",a,b,c); }\n'
        fout.write(fstr)

    fout.write('\n')

    for q in qgates_4: #PrepZ, PrepX
        instFnName = 'qg_'+q
        fstr = 'void '+instFnName+'(char* a, int i){ printf("' +gateNames[q] +' %s\\n",a); '
        fout.write(fstr)
        fstr = 'if(i==1){ printf("X %s\\n",a); } }\n'
        fout.write(fstr)

    fout.write('\n')

    for q in qgates_5: #MeasX, MeasZ
        instFnName = 'qg_'+q
        fstr = 'void '+instFnName+'(char* a){ printf("' +gateNames[q] +' %s\\n",a); }\n'
        fout.write(fstr)

    fout.write('\n')

    for q in qgates_6:
        instFnName = 'qg_'+q
        fstr = 'void '+instFnName+'(char* a, double b){ printf("' +gateNames[q] +' %s,%f\\n",a,b); }\n'
        fout.write(fstr)
    
    for q in qgates_7:
        instFnName = q
        fstr = 'void '+instFnName+'(char** a, int b ){ for(int i = 0; i < b; i++){ printf("' +gateNames[q] +' %s\\n",(*a)); a++; }}\n'
                
        fout.write(fstr)


    fout.write('\n')


    #ignore contents until QASM Generation Pass                                                                         
    f = open(fname,'r')
    b = 'Dummy Line'
    while(b!=''):
        if(b.find('QASM Generation Pass:')!=-1):
            break
        b = f.readline()

    b = f.readline()

    inMainFunc = False
    setQbitDecl = []
    setCbitDecl = []


    while(b!=''):
        if(b.find('End of QASM generation')!=-1):
            break

        #check for qbit declarations                
        m = re.match(pattern_main,b)
        if(m):
            inMainFunc = True
            b = re.sub(r"\bvoid|module\b","int ",b)

        m = re.match(pattern_qbit_decl,b)

        if(m): #Matched qbit declaration
            numElem = int(m.group('array_size'))
            var = m.group('qbit_var')

            addAlphabet=''
            if(not inMainFunc):
                addAlphabet='a' #add 'a' at end of ancilla declaration
    
            subStr = "char* "+m.group('qbit_var')+'['+m.group('array_size')+'] = {'
            fout.write(subStr)
                        
            for i in range(numElem-1):                
                varName = var+str(i)+addAlphabet
                tmp = '"'+varName+'",'
                if varName not in setQbitDecl:
                    setQbitDecl.append(varName)
                fout.write(tmp)
                
            varName = var+str(numElem-1)+addAlphabet
            tmp = '"'+varName+'"'            
            if varName not in setQbitDecl:
                setQbitDecl.append(varName)
            fout.write(tmp)
            fout.write('};\n')                          

        else:
            m = re.match(pattern_qg,b)
            if(m):    #Matched qauntum gate call                            
                qstr = m.group('func_name')
                
                if qstr in qgates:
                    rstr = 'qg_'+qstr
                
                    mystr = b.replace(qstr,rstr)

                    #check for Meas gates
                    m1 = re.match(pattern_meas,mystr)
                    if(m1):
                        retStr = m1.group('func_ret')
                        
                        if(retStr):
                            mystr = mystr.replace(retStr,'')

                    fout.write(mystr)                            

                else:
                    fout.write(b)
                
            else:                                                
                #substitute qbit as char* in module definitions                
                m = re.match(pattern_qbit_arg,b)
                                
                if(m):
                    mystr = b
                    mystr = re.sub(r"\bqbit\b","char* ",mystr)
                    fout.write(mystr)

                else:
                    m = re.match(pattern_cbit_decl,b)
                    if(m):
                        numElem = int(m.group('array_size'))
                        var = m.group('qbit_var')


                        subStr = "char* "+m.group('qbit_var')+'['+m.group('array_size')+'] = {'
                        fout.write(subStr)
                        
                        for i in range(numElem-1):
                            tmp = '"'+var+str(i)+'",'
                            setCbitDecl.append(var+str(i))
                            fout.write(tmp)

                        tmp = '"'+var+str(numElem-1)+'"'
                        setCbitDecl.append(var+str(numElem-1))
                        fout.write(tmp)
                        fout.write('};\n')
                    else:
                        m = re.match(pattern_comment,b)
                        if(m):
                            subStr = 'printf("'+b.rstrip('\n')+'\\n");'
                            fout.write(subStr)

                        else:
                            #print 'Did not match any pattern:',b
                            fout.write(b)

        
        b = f.readline()

    f.close()

    fout.close()

    #write qbit and cbit declarations to file
    fdecl = open("fdecl.out",'w')
    for q in setQbitDecl:
        myStr = 'qubit '+q+'\n'
        fdecl.write(myStr)
    for q in setCbitDecl:
        myStr = 'cbit '+q+'\n'
        fdecl.write(myStr)
    fdecl.close()
        

parser = argparse.ArgumentParser(description='Convert QASM code into flattened QASM code')
parser.add_argument("input")
args = parser.parse_args()

process_qasm(args.input)

back to top

Software Heritage — Copyright (C) 2015–2025, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API