Skip to main content

Replace ADS citations with the appropriate INSPIRE ones in latex and bibtex

Project description

github PyPI version DOI Conda Version license

ads2inspire

Replace ADS citations with the appropriate INSPIRE ones in latex and bibtex

Why? Because ADS citation keys are not stable: they start out as something like 2019arXiv191207609s, and after being accepted to a journal turn into something like 2020PhRvD.101f4007S. This means you have to rewrite your latex, or you might even end up citing both entries!

Installation

From PyPI

In your Python environment run

python -m pip install ads2inspire

From conda-forge

In your conda environment run

conda install -c conda-forge ads2inspire

From this repository

In your Python environment from the top level of this repository run

python -m pip install .

From GitHub

In your Python environment run

python -m pip install "git+https://github.com/duetosymmetry/ads2inspire.git#egg=ads2inspire"

Usage

First latex/bibtex/latex your file, then run

ads2inspire [--backup] [--filter-type [ads|all]] [--fill-missing] auxfile.aux [texfile1.tex [texfile2.tex [...]]]

If your main tex file is named wonderful.tex, then your auxfile will be named wonderful.aux. ads2inspire will read the aux file, query INSPIRE, then rewrite all the texfiles named on the command line, and append to the first bibtex file named in auxfile. The option --backup will make the program write backups of the tex and bib files before rewriting them. The option --filter-type controls which keys to search for on INSPIRE: the default "ads" will only search for keys that look like ADS keys, while "all" will try all keys (aside from those that look like INSPIRE keys). The --fill-missing flag will query for INSPIRE-like keys that were referenced in the LaTeX source, but missing from the .bib file, and fill them into the .bib file if found.

Contributing

Note that I have done very little testing! Want to pitch in and help make this code better? Please fork and send me PRs!

TODO:

  • More testing
  • More filter types
  • more?

Citation

The preferred BibTeX entry for citation of ads2inspire is

@software{ads2inspire,
  author = "{Stein, Leo C. and Feickert, Matthew}",
  title = "{ads2inspire: v0.3.1}",
  version = {v0.3.1},
  doi = {10.5281/zenodo.3903987},
  url = {https://github.com/duetosymmetry/ads2inspire},
}

Project details


Download files

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

Files for ads2inspire, version 0.3.1
Filename, size File type Python version Upload date Hashes
Filename, size ads2inspire-0.3.1-py2.py3-none-any.whl (9.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size ads2inspire-0.3.1.tar.gz (10.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page