Skip to content

Commit

Permalink
format
Browse files Browse the repository at this point in the history
  • Loading branch information
teuben committed Sep 3, 2021
1 parent 4d71417 commit 6d07ff7
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions API/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,17 @@ The publically available database fields that you can access through the API are
| ---- | ------------ |
abstract| Brief description of the code
ascl\_id | The human-friendly version of an ASCL id. Format is YYMM.### where YY is the year, MM is the month, and ### is an incrementing integer padded with zeroes.
bibcode | A 19-digit bibliographic code that allows the entry to be uniquely identified in several indexing services such as the SAO/NASA Astrophysics Data System (ADS). More information about this identifier appears on the ADS website (http://doc.adsabs.harvard.edu/abs\_doc/help\_pages/data.html#bibcodes).

bibcode | A 19-digit bibliographic code that allows the entry to be uniquely identified in several indexing services such as the SAO/NASA Astrophysics Data System (ADS).
More information about this identifier appears on the ADS website
(http://doc.adsabs.harvard.edu/abs_doc/help_pages/data.html#bibcodes
or https://ui.adsabs.harvard.edu/help/actions/bibcode).


citation\_method | How the code should be cited, according to the author(s) or website of the code. As a courtesy to the code author(s), please check the code website to verify the citation preference.

credit | Normalized list of author names, not serialized

described\_in | Paper in which the code is described ("code paper"); this is typically a refereed paper written by the software author(s), though may not be refereed if there is a "used in" paper
keywords | Serialized array in a text field of words or phrases that are associated with the entry. Currently this field is used to identify software that is associated with NASA (National Aeronautics and Space Administration) and HITS (Heidelberg Institute for Theoretical Studies).
site\_list | Serialized array of websites associated with a code, including a download site
Expand Down Expand Up @@ -67,7 +75,7 @@ queries, or the logical AND of the filters.

# Examples
1. Example of a general, non-fielded query. This will search all public fields and return codes which contain the phrase "machine learning".
https://ascl.net/api/search/?q="machine%20learning")
https://ascl.net/api/search/?q="machine learning"


2. Example of a query with a filter query attached. This will search for public fields with the phrase "machine learning" whose time updated is greater than X
Expand Down

0 comments on commit 6d07ff7

Please sign in to comment.