author_list_notion

script to automatically generate authors, insitutes, and acknowledgments lists for scientific publications.

Created by Adrien Leleu and modified by Chris Broeg. ORCID update by Luisa Serrano.

Version 2.0 reads not the CSV file but directly reads the Notion DB of the CHEOPS ST.

Overview

The author_list tool was mainly devoloped to be used in the frame of the ESA CHEOPS mission for the Science Team publications. It automatically fulfills the CHEOPS publication policy and allows to use a homogenized author database.

Major changes in 2.0

• Reads Notion DB online (requires notion-server-details.yaml obtained from CHEOPS ST)
• In addition or instead a custom CSV file (filename configurable, default: additional_authors.csv) can be used
• No edits are done to the python code
• All configuration parameters and author lists are now done in the config file: author_list_config.yaml
• file renamed to author_list_notion.py
• dependencies for notion_client and yaml added

Inputs

• internet connection required to connect to Notion DB
• notion-server-details.yaml obtained from CHEOPS ST (plone) for access details
• Configuration file author_list_config.yaml

Adding authors not in the DB

The script uses the Notion DB data containing all members of the CHEOPS Science Team and associated authors (formerly in "CHEOPS_Science_Team.csv"). Additional authors can still be specified in a CSV file of the same format. Mandatory columns are:

• "Ref name": names to use as reference when building the first and special author list
• "ID": group id that the author belongs to used to identify in List_of_ID_to_add, Multiple entries must be separated by ";"
• "ORCID": ORCID ID if available. Linked to author name if flag_orcid = True
• "surname"
• "First name": first name including additional initials
• "Adress": affiliation to print in the article. Multiple entries must be separated by ";"
• "Acknow": acknowledgements. Muliple entries separated by ";"
• "joined": date of joining the team; mandatory field for members of the List_of_ID_to_add
• "Departed": date of leaving the team; mandatory field for members of the List_of_ID_to_add

Editing the author_list_config.yaml

The tool must be configured by editing the yaml file. The following items have to be edited:

A number of lists must be populated using "Ref name":

• paper_date date of the paper - to select the people on the team at the time
• lead_author
• major_contirbutors_list: additional key contributors to the paper (typically up to 4)
• science_enablers_list: 4 science enables chosen from the science_enablers_list_full
• significant_contributors_list: up to 15% listed before the alphabetical list
• MA_nominees: name 5 people selected by the mission architects (will be added to the alphabetical list)
• selected_list: additional authors in the alphabetical order not in List_of_ID_to_add

All members of the following group IDs will be added in alphabetical order:

List_of_ID_to_add = ['CST','Associate','Board', 'EO', 'MA', 'ESAPS']

These lists define the content and order of the author list. The order will be as in the bullet list above.

In addition, the following configurations are possible:

• flag_initials: set to False if you want to print full Names, not initials
• flag_orcid: set to False if you don't want the link to orcid ID in the author list
• affil: LaTex command to use for institue (Replace by your journal needs, e.g. one of the following examples: affil = r"\affil"; affil = r"$^"
• author_separator = ", ": separator used between authors: ", " or "\and"
• flag_inst_label = True: how to enumerate the institutes: True: uses \label{inst:nn}, False uses $^{nn}$

Output

Simply run the code as

> python author_list_notion.py

in the same directory as the CSV file and it will output the following files:

• authors.txt: latex code to include in the paper to list the authors.
• authors_lin.txt: simple list of authors
• institutes.txt: latex code to include in the paper for the institues with the appropriate idexes for the author list
• acknowledgements.txt: the string to put for acknowledgements. This part may need some manual editing in case of overlaps of almost similar text.
• acknowledgements_magic_merge.txt: like the previous but same text starting with xxx acknowledge will be merged into one.

Updating the database

The notion DB is kept up to date. If you have a request for modification please contact the ST chair or the mission manager.