make-authorlist.py

#!/usr/bin/python3
#
# Makes the XENON Latex authorlist for different journal styles
#
# Patrick Decowski, decowski@nikhef.nl
#

from datetime import datetime
import re
import sys

def print_header():
    '''Print the default header at the beginning of the Latex output'''
    print('% Autogenerated on ' + datetime.now().strftime("%d %b, %Y at %H:%M:%S"))
    print('% Generated with make-authorlist.py')
    
def format_prl(authorlist, institutes):
    '''Format for PRL/PRC/PRD etc. '''
    print_header()
    print(r'''
% -> SNIP
\documentclass[prl,aps,twocolumn,superscriptaddress,showpacs,showkeys,amsmath,amssymb,floatfix]{revtex4}
\usepackage[colorlinks=true,citecolor=blue,filecolor=blue,linkcolor=blue,urlcolor=blue,pdftex]{hyperref}
\usepackage{currfile} % To be able to list current file name in title
% <- SNIP
''')
    
    for institute in institutes:
        inst = '\\newcommand{\\' + institute + r'}{\affiliation{' + institutes[institute] + '}}'
        print(inst)

    print(r'''
\begin{document}

% CHANGE TO TITLE
\title{XENON Authors \currfilename}
''')
    
    for author in authorlist:
        auth = r'\author{' + author['name'] + '}'
        if author['alsoat']:
            auth = auth + r'\altaffiliation[Also at ]{' + institutes[author['alsoat']] + '}'
        for inst in author['institute']:
            auth = auth + '\\' + inst
        print(auth)
    print(r'''
\collaboration{XENON Collaboration}
\email[]{xenon@lngs.infn.it}
\noaffiliation

\date{\today} 

% CHANGE
\begin{abstract}
\end{abstract}

\keywords{Dark Matter, Direct Detection, Xenon}

% <--- SNIP 
\maketitle

\end{document}
''')

def format_epjc(authorlist, institutes):
    '''Format for EPJC'''
    print_header()
    print("% NOTE!!! For proper formatting you need epjc3upd.clo !")
    print(r'''
% -> SNIP
\documentclass[epjc3upd,twocolumn]{svjour3}
\usepackage{currfile} % To be able to list current file name in title
% <- SNIP

\journalname{Eur. Phys. J. C}

\begin{document}

% CHANGE TO TITLE
\title{XENON Authors \currfilename}
''')

    addr_label = {}
    # for EPJC we need an extra level of indirection for addr labels
    for indx, institute in enumerate(institutes):
        addr_label[institute] = 'addr' + str(indx)

    alsoat = []
    sorted_inst = []
    first = True
    for author in authorlist:
        addr = ""
        auth = ""
        if first:
            auth = r'\author{'
            first = False
        else:
            print(r'\and')            
        for inst in author['institute']:
            if addr != "": 
                addr = addr + "," + addr_label[inst]
            else:
                addr = addr_label[inst]
            if not inst in sorted_inst:
                sorted_inst.append(inst)
        if author['alsoat']: # We need to build the list of alsoat institutes
            addr = addr + "," + addr_label[author['alsoat']]
            alsoat.append(author['alsoat'])
        auth = auth + author['name'] + r'\thanksref{' + addr + '}'
        print(auth)
    print(r'(XENON Collaboration\thanksref{email1}). }')
    for institute in institutes:
        inst = '\\newcommand{\\' + institute + '}{' + institutes[institute] + '}'
        print(inst)

    print(r'\authorrunning{XENON Collaboration}')
    for inst in alsoat:
        txt = r'\thankstext{' + addr_label[inst] + '}{Also at \\' + inst + '}'
        print(txt)

    print(r'''
% ADD Corresponding Author Email here:
\thankstext{email1}{\texttt{xenon@lngs.infn.it}}''')

    first = True
    alsoat_dict = dict.fromkeys(alsoat, True)
  
    for institute in sorted_inst:
        if institute in alsoat_dict: # Skip the AlsoAt institutes
            continue
        inst = ""
        if first:
            inst = r'\institute{'
            first = False
        else:
            print(r'\and')
        inst = inst + '\\' + institute + r'\label{' + addr_label[institute] + '}'
        print(inst)
    print(r'''}
\maketitle
\end{document}
''')

def format_jcap(authorlist, institutes):
    '''Format for JCAP journal'''
    print_header()
    print(r'''
% -> SNIP
\documentclass[a4paper]{article}
\usepackage{jcappub}
\usepackage{currfile} % To be able to list current file name in title
% <- SNIP

% CHANGE TO TITLE
\title{XENON Authors \\currfilename}

\author{The XENON collaboration: }''')

    inst_label = {}
    inst_label_ordered = []
    also_label = {}
    indx = 0
    indx_also = 0
    first_auth = True
    auth = ''
    post = ''
    for author in authorlist:
        if not first_auth:
            auth = auth + ',' + post + '}'
            print(auth)
        auth = r'\author['
        first_inst = True
        for inst in author['institute']:
            if not first_inst:
                auth = auth + ','
            if not inst in inst_label:
                label = ''
                for i in range(0, int(indx/26)):
                    label = chr(0x61 + i) # ASCII-code 'a'
                inst_label[inst] = label + chr(0x61 + (indx % 26))
                inst_label_ordered.append(inst) # Order according to use in list
                indx = indx + 1
            auth = auth + inst_label[inst]
            first_inst = False
            post = ''
        if author['alsoat']:
            if not author['alsoat'] in also_label:
                also_label[author['alsoat']] = chr(0x31 + indx_also)
            auth = auth + ',' + also_label[author['alsoat']]
            post = '\\note{Also at: ' + institutes[author['alsoat']] + '}'
            indx_also = indx_also + 1
        else:
            post = ''
        auth = auth + r']{' + author['name']
        first_auth = False
    # Last author is special because list ends with a period and not comma
    auth = auth + post + '.}'
    print(auth)

    # Make the affiliations
    for inst in inst_label_ordered:
        affil = r'\affiliation[' + inst_label[inst] + ']{' + institutes[inst] + '}'
        print(affil)

    print(r'''
\keywords{Dark matter experiments, dark matter simulations}

\begin{document}
\maketitle

\end{document}
''')


def format_ptep(authorlist, institutes):
    '''Format for PTEP '''
    print_header()
    print(r'''
% NOTE: there is a nasty bug in the PTEP style file! You need to replace the 
% newlogo.eps file with an essentially empty newlogo.png. If you don't the
% formatting of the authorlist becomes crooked. 
%
% -> SNIP
\documentclass{ptephy_v1}
\usepackage{currfile} % To be able to list current file name in title
% <- SNIP
''')
    print(r'''
\begin{document}

% CHANGE TO TITLE
\title{XENON Authors \currfilename}
''')

    inst_label = {}
    inst_label_ordered = []
    also_label = {}
    indx = 1
    indx_also = 1
    first_auth = True
    auth = ''
    post = ''
    for author in authorlist:
        if not first_auth:
            auth = auth + post + '}'
            print(auth)
        auth = r'\author['
        first_inst = True
        for inst in author['institute']:
            if not first_inst:
                auth = auth + ','
            if not inst in inst_label:
                label = str(indx)
                inst_label[inst] = label
                inst_label_ordered.append(inst) # Order according to use in list
                indx = indx + 1
            auth = auth + inst_label[inst]
            first_inst = False
            post = ''
        if author['alsoat']:
            post = r'\thanks{Also at ' + institutes[author['alsoat']] + '}'
            indx_also = indx_also + 1
        else:
            post = ''
        auth = auth + r']{' + author['name']
        first_auth = False
    # Last author is special because list ends with a period and not comma
    auth = auth + post + '}'
    print(auth)

    # Make the affiliations
    for inst in inst_label_ordered:
        affil = r'\affil[' + inst_label[inst] + ']{' + institutes[inst] + '}'
        print(affil)

    print(r'''
\collaborator{XENON Collaboration\email{xenon@lngs.infn.it}}

\date{\today} 

% CHANGE
\begin{abstract}
\end{abstract}

% <--- SNIP 
\maketitle

\end{document}
''')


def format_arxiv(authorlist, institutes):
    '''Format for arXiv - during submission'''
    output = ""
    first = True
    for author in authorlist:
        auth = author['name']
        auth = auth.replace('~', ' ')
        if first:
            output = auth
            first = False
        else:
            output = output + ', ' + auth
    print(output)
        
def read_authorlist(filename):
    ''' Read the XENON author list in the format: author: affil1, affil2 % comment'''

    rx = re.compile(r'(?P<name>.*)\:\s*(?P<institute>\S*)\s*?\%?\s*(?P<comment>.*)\n')
    rx_inst = re.compile(r'(?P<inst1>\w+)\,?(?P<inst2>\w*)')
    rx_also = re.compile(r'.*?(?P<alsoat>alsoat\w*)')
    rx_instaddr = re.compile(r'(?P<institute>.*)\s\@\s(?P<address>.*)\n')

    authorlist = []
    institutes = {}
    with open(filename, 'r') as file:
        for line in file:
            if line[0] == "#":
                # Skip comments
                continue
            match = rx.search(line)
            match_institute = rx_instaddr.search(line)
            if match:
                author = { }
                author['name'] = match.group("name")
                m = rx_inst.search(match.group("institute"))
                a = rx_also.search(match.group("institute"))
                institute = [] # Can be multiple institutes
                for inst in m.groups():
                    if (a and inst == a.group("alsoat")) or inst == "":
                        continue
                    institute.append(inst)
                author['institute'] = institute
                if a:
                    author['alsoat'] = a.group("alsoat")
                else:
                    author['alsoat'] = None
                authorlist.append(author)
            elif match_institute:
                institute = match_institute.group("institute")
                address = match_institute.group("address")
                institutes[institute] = address
            else:
                print("Failed on:", line)
                sys.exit(1)
    return authorlist, institutes

def check_authorlist(authorlist, institutes):
    for author in authorlist:
        for inst in author['institute']:
            if institutes[inst] == None:
                print("No institute defined for", author['name'])
            if author['alsoat']:
                if institutes[author['alsoat']] == None:
                    print("No institute defined for", author['name'])

                    
def usage():
    print("make-authorlist.py --prl | --epjc | --jcap | --ptep | --arxiv filename")
    sys.exit(0)
    
options = { "--prl": format_prl,
            "--epjc": format_epjc,
            "--jcap": format_jcap,
            "--ptep": format_ptep,
            "--arxiv": format_arxiv,
            "--help": usage }


if __name__ == "__main__":
    if len(sys.argv) != 3:
        usage()
    option = sys.argv[1]
    filename = sys.argv[2]
    authorlist, institutes = read_authorlist(filename)
    check_authorlist(authorlist, institutes)
    try:        
        options[option](authorlist, institutes)
    except KeyError:
        usage()