Skip to main content

Set of simple tools for working in DES.

Project description

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

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

The ``mkauthlist`` script is distributed via ``pip``:

.. code-block::
> pip install mkauthlist

You can also clone this directory and install by hand:

.. code-block::
> git clone git@github.com:kadrlica/mkauthlist.git
> cd mkauthlist
> python setup.py install

Usage
----

The core usage is to transform a pre-sorted file of comma separated values into an author list suitable for input in the latex. The ``mkauthlist`` script provides several options for more complicated operations when generating the list.

.. 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
-------
Start with the author list file generated by the PubDB system (for DES members, see here_).

.. _here: http://dbweb6.fnal.gov:8080/DESPub/app/PB/pub/author_list/DES-2015-0109_author_list.csv?pubid=109

.. code-block::
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

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.2.tar.gz (21.9 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for mkauthlist-0.4.2.tar.gz
Algorithm Hash digest
SHA256 9c7e6ea4d38bca1113a3f0a6cc8313e87c46afc81f5dfc80096010b99772075d
MD5 f2f80e1e0e5ecce14cb51ac52c25a361
BLAKE2b-256 18985993b69d2bf8392f0bffdf526c561bec3516290a1a2a4cc323c3ebc353c7

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