Git Product home page Git Product logo

citebot's Introduction

citebot

badge-img

A helpful bot that tells you if you've missed citations in your astrophysics paper.

Installation

To install the citebot script, run

pip install citebot

or

python setup.py install

in this directory to get the development version.

Most of the heavy lifting will be done using the ads library so you'll need to make sure that you have your ADS API key set up properly by following the docs.

Usage

The assumption is that, if you're writing an astrophysics paper, you're probably using NASA ADS, and this code will only work if (at least some of) your BibTeX entries were exported by ADS. To get a list of recommended references, you can run

citebot /path/to/a/bibtex/file.bib

This will print a list of recommended citations to the terminal which is useful, but probably not exactly what you want. Instead, the best way to use this is probably to include the --upload argument to convert the recommendations to an ADS personal library:

citebot /path/to/a/bibtex/file.bib --upload name_of_the_library --clobber

where the --clobber command will overwrite an existing library with the same name (without asking).

citebot's People

Contributors

dfm avatar ruthangus avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.