ads2inspire

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

https://github.com/duetosymmetry/ads2inspire

Science Score: 59.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.6%) to scientific vocabulary

Keywords

bibliography bibtex latex python
Last synced: 6 months ago · JSON representation

Repository

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

Basic Info
  • Host: GitHub
  • Owner: duetosymmetry
  • License: mit
  • Language: Python
  • Default Branch: master
  • Size: 37.1 KB
Statistics
  • Stars: 9
  • Watchers: 3
  • Forks: 0
  • Open Issues: 2
  • Releases: 4
Topics
bibliography bibtex latex python
Created over 5 years ago · Last pushed about 3 years ago
Metadata Files
Readme License Zenodo

README.md

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 "ads2inspire@git+https://github.com/duetosymmetry/ads2inspire.git"

Usage

First latex/bibtex/latex your file, then run

shell 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}, }

Owner

  • Name: Leo C. Stein
  • Login: duetosymmetry
  • Kind: user

Assistant Professor of Physics and Astronomy at U of MS. Gravitational waves, general relativity and beyond. Formerly at @caltech, @mit, Cornell

GitHub Events

Total
  • Pull request event: 1
Last Year
  • Pull request event: 1

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 37
  • Total Committers: 2
  • Avg Commits per committer: 18.5
  • Development Distribution Score (DDS): 0.27
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Leo C. Stein l****n@g****m 27
Matthew Feickert m****t@c****h 10
Committer Domains (Top 20 + Academic)
cern.ch: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 6
  • Total pull requests: 9
  • Average time to close issues: 2 days
  • Average time to close pull requests: about 12 hours
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 1.5
  • Average comments per pull request: 1.33
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • matthewfeickert (5)
  • duetosymmetry (1)
Pull Request Authors
  • matthewfeickert (5)
  • duetosymmetry (4)
Top Labels
Issue Labels
tests (2) enhancement (2)
Pull Request Labels
enhancement (3) documentation (2) API (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 66 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 9
  • Total maintainers: 2
pypi.org: ads2inspire

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

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 66 Last month
Rankings
Dependent packages count: 9.7%
Stargazers count: 18.5%
Dependent repos count: 21.9%
Average: 21.9%
Downloads: 29.6%
Forks count: 29.9%
Maintainers (2)
Last synced: 6 months ago
conda-forge.org: ads2inspire

ads2inspire is a command-line utility (and package) for replacing ADS citations with the appropriate INSPIRE ones in latex and bibtex. It is pure Python code with minimal dependencies.

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 34.0%
Average: 49.9%
Dependent packages count: 51.2%
Stargazers count: 53.5%
Forks count: 61.1%
Last synced: 6 months ago

Dependencies

.github/workflows/publish-package.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish v1.2.2 composite
pyproject.toml pypi
setup.py pypi