Name: tpub
Owner: TESS Guest Investigator Program
Description: Keep track of the publications related to TESS mission.
Created: 2017-04-14 14:45:26.0
Updated: 2017-04-14 14:46:29.0
Pushed: 2018-02-22 20:50:08.0
Size: 47930
Language: Python
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
A database of scientific publications related to NASA's TESS mission.
tpub is a mission-specific tool that enables NASA's TESS Guest Investigator
Office to keep track of its mission's scientific publications in an easy way.
It leverages SQLite and the ADS API
(using Andy Casey's awesome Python client)
to create and curate a database that contains the metadata
of mission-related articles. This is a fork of kpub which is used to track Kepler/K2 publications. kpub was written by Geert Barentsen
Print a nicely-formatted list of Kepler-related exoplanet publications in markdown format:
--exoplanets
Add a new article to the database using its bibcode. This command will display the article's metadata and ask the user to classify the science:
-add 2015arXiv150204715F
Remove an article using its bibcode:
-delete 2015ApJ...800...46B
Search ADS interactively for new Kepler-related articles and try to add them:
-update 2015-07
For example output, see the data/output/ sub-directory in this repository.
To install the latest version from source:
clone https://github.com/tessgi/tpub.git
pub
on setup.py install
Note that the tpub tools will use ~/.tpub.db as the default database file.
This repository contains a recent version
of the database file (data/tpub.db),
which you may want to link to the default file as follows:
s /path/to/git/repo/data/tpub.db ~/.tpub.db
The tpub-addand tpub-update tools that come with this package require
an api key from NASA ADS labs to retrieve publication meta-data.
You need to follow the installation instructions of the ads client by @andycasey to make this work.
tpub adds a number of tools to the command line (described below).
There is a Makefile which makes your life easy if you work
for the GI office and are updating the database.
Simply type:
make update to search for new publications;make push to push the updated database to the git repo;make refresh to export and import all publications, this is slow and necessary only if you want to remove duplicates and fetch fresh citation statistics.After installation, this package adds the following command-line tools to your path:
tpub prints the list of publications in markdown format;tpub-update adds new publications by searching ADS (interactive);tpub-add adds a publication using its ADS bibcode;tpub-delete deletes a publication using its ADS bibcode;tpub-import imports bibcodes from a csv file;tpub-export exports bibcodes to a csv file;tpub-plot creates a visualization of the database;tpub-spreadsheet exports the publications to an Excel spreadsheet.Listed below are the usage instructions for each command:
tpub
ub --help
e: kpub [-h] [-f dbfile] [-e] [-a] [-k] [-2] [-m]
the TESS publication list in markdown format.
onal arguments:
, --help show this help message and exit
dbfile Location of the TESS publication list db. Defaults
to ~/.tpub.db.
, --exoplanets Only show exoplanet publications.
, --astrophysics Only show astrophysics publications.
, --month Group the papers by month rather than year.
kpub-update
ub-update --help
e: tpub-update [-h] [-f dbfile] [month]
ractively query ADS for new publications.
tional arguments:
nth Month to query, e.g. 2015-06.
onal arguments:
, --help show this help message and exit
dbfile Location of the TESS publication list db. Defaults to
~/.tpub.db.
tpub-add
ub-add --help
e: tpub-add [-h] [-f dbfile] bibcode [bibcode ...]
a paper to the TESS publication list.
tional arguments:
bcode ADS bibcode that identifies the publication.
onal arguments:
, --help show this help message and exit
dbfile Location of the TESS publication list db. Defaults to
~/.tpub.db.
tpub-delete
ub-delete --help
e: tpub-delete [-h] [-f dbfile] bibcode [bibcode ...]
tes a paper from the TESS publication list.
tional arguments:
bcode ADS bibcode that identifies the publication.
onal arguments:
, --help show this help message and exit
dbfile Location of the TESS publication list db. Defaults to
~/.tpub.db.
kpub-import
ub-import --help
e: tpub-import [-h] [-f dbfile] csvfile
h-import papers into the TESS publication list from a CSV file. The
file must have three columns (bibcode,mission,science) separated by
as. For example: '2004ApJ...610.1199G,tess,astrophysics'.
tional arguments:
vfile Filename of the csv file to ingest.
onal arguments:
, --help show this help message and exit
dbfile Location of the TESS publication list db. Defaults to
~/.tpub.db.
tpub-export
ub-export --help
e: tpub-export [-h] [-f dbfile]
rt the TESS publication list in CSV format.
onal arguments:
, --help show this help message and exit
dbfile Location of the TESS publication list db. Defaults to
~/.tpub.db.
tpub-spreadsheet
ub-spreadsheet --help
e: tpub-spreadsheet [-h] [-f dbfile]
rt the TESS publication list in XLS format.
onal arguments:
, --help show this help message and exit
dbfile Location of the TESS publication list db. Defaults to
~/.tpub.db.
kpub was created by Geert Barentsen (geert.barentsen at nasa.gov) on behalf of the Kepler/K2 Guest Observer Office.
tpub is a fork of kpub that creates a list of TESS publications, rather than Kepler/K2. The tpub fork was created by Tom Barclay (thomas.barclay at nasa.gov) on behalf of the TESS Guest Investigator Office.
This tool is made possible thanks to the efforts made by NASA ADS to provide a web API, and thanks to the excellent Python client that Andy Casey (@andycasey) wrote to use the API.
We also thank Geert cos he wrote nearly all the code here.