Skip to main content

Set of simple tools for working in DES.

Project description

mkauthlist
==========
Make long latex author lists from csv files.

Installation
------------


Usage
----

.. code-block::

> mkauthlist --help
usage: mkauthlist [-h] [-a order.csv] [-d] [-f] [-i IDX]
[-j {aj,apj,elsevier,emulateapj,mnras,prd,prl}] [-s] [-V]
author_list.csv
[author_list.tex]

A simple script for making latex author lists from the csv file
produced by the DES Publication Database (PubDB).

Some usage notes:
(1) By default, the script does not tier or sort the author list. The
'--sort' option does not respect tiers.
(2) An exact match is required to group affiliations. This should not
be a problem for affiliations provided by the PubDB; however, be
careful if you are editing affiliations by hand.
(3) The script parses quoted CSV format. Latex umlauts cause a problem
(i.e., the Munich affiliation) and must be escaped in the CSV
file. The PubDB should do this by default.
(4) There are some authors in the database with blank
affiliations. These need to be corrected by hand in the CSV file.

positional arguments:
DES-XXXX-XXXX_author_list.csv
Input csv file from DES PubDB
DES-XXXX-XXXX_author_list.tex
Output latex file (optional).

optional arguments:
-h, --help show this help message and exit
-a order.csv, --aux order.csv
Auxiliary author ordering file (one lastname per
line).
-d, --doc Create standalone latex document.
-f, --force Force overwrite of output.
-i IDX, --idx IDX Starting index for aastex author list (useful for
multi-collaboration papers).
-j {aj,apj,elsevier,emulateapj,mnras,prd,prl}, --journal {aj,apj,elsevier,emulateapj,mnras,prd,prl}
Journal name or latex document class.
-s, --sort Alphabetize the author list (you know you want to...).
-V, --version Print version number and exit.


Example
-------

.. code-block::
# Start with the author list file generated by the PubDB system:
# http://dbweb6.fnal.gov:8080/DESPub/app/PB/pub/author_list/DES-2015-0109_author_list.csv?pubid=109

base="example_author_list"
csv="${base}.csv"
tex="${base}.tex"
pdf="${base}.pdf"
png="${base}.png"

authlist.py --sort -f --doc -j emulateapj $csv $tex
pdflatex $tex
convert $pdf $png
open $pdf


The output should looks something like this:

.. image:: data/example_author_list.png

One common usecase is to sort the builder list but not the first tier authors. This can be achieved by adding an auxiliary order file ``--aux order.csv`` specifying the ordering of the first tier authors and then alphabetically sorting the list with the ``--sort`` option.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkauthlist-0.4.0.tar.gz (21.9 kB view details)

Uploaded Source

File details

Details for the file mkauthlist-0.4.0.tar.gz.

File metadata

  • Download URL: mkauthlist-0.4.0.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for mkauthlist-0.4.0.tar.gz
Algorithm Hash digest
SHA256 f27e029c04dc13ab663055315513430cb3ce0a738c348f0298cb8533b87a8dc5
MD5 7bdc2bb65c9c311520bae0999dd7ee72
BLAKE2b-256 c53a1b6bbdbc72ae9894cb51a888e544be056b9cda5347fe14222bddcb020870

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page