arXiv

https://info.arxiv.org/
Admin
arXiv is a curated research-sharing platform open to anyone, hosting millions of scholarly articles...
Tokens:132,211
Snippets:2,098
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Paging Through API Results

Source: https://info.arxiv.org/help/api/user-manual.html

Examples of using start and max_results parameters to retrieve result chunks sequentially.

```text
http://export.arxiv.org/api/query?search_query=all:electron&start=0&max_results=10 (1)
http://export.arxiv.org/api/query?search_query=all:electron&start=10&max_results=10 (2)
http://export.arxiv.org/api/query?search_query=all:electron&start=20&max_results=10 (3)
```

--------------------------------

### File structure example for supplemental material

Source: https://info.arxiv.org/help/submit_legacy_differences.html

Example of a file list in the root directory for TeX compilation.

```text
  ./ms.tex
  ./ms.bbl
  ./myfig.eps
  ./supplement.tex
  ./supplement.bbl
```

--------------------------------

### OpenURL Resolver Examples

Source: https://info.arxiv.org/help/openurl.html

Example request URLs for the arXiv trial resolver using different OpenURL versions.

```text
http://arXiv.org/openurl-resolver?id=oai%3AarXiv.org%3Acs.DL%2F0106057
```

```text
http://arXiv.org/openurl-resolver?rft_id=ori%3Aoai%3AarXiv.org%3Acs.DL%2F01060577&url_ver=Z39.88-2004
```

--------------------------------

### Typical TeX installation directory path

Source: https://info.arxiv.org/help/faq/pstricks.html

A common directory path for PSTricks files in a standard TeX installation.

```text
/usr/local/teTeX/texmf/dvips/pstricks/
```

--------------------------------

### Example S3 Keys for PDF Tar Files

Source: https://info.arxiv.org/help/bulk_data_s3.html

List of example S3 keys representing the chunked tar files containing PDF data.

```text
pdf/arXiv_pdf_1001_001.tar         (s3://arxiv/pdf/arXiv_pdf_1001_001.tar in s3cmd URI style)
pdf/arXiv_pdf_1001_002.tar         (s3://arxiv/pdf/arXiv_pdf_1001_002.tar)
pdf/arXiv_pdf_1001_003.tar         (s3://arxiv/pdf/arXiv_pdf_1001_003.tar)
```

--------------------------------

### Example arXiv XML Record

Source: https://info.arxiv.org/help/oa/arXiv_meta_format.html

A concrete example of an arXiv record retrieved via the Dienst interface.

```xml
Content-type: text/xml

<?xml version="1.0" encoding="UTF-8"?>
 <Disseminate version="1.0">
  <arXiv:arXiv xmlns:arXiv="http://arXiv.org/help/oa/arXiv\_meta\_format">
   <arXiv:Id>math/9901016</arXiv:Id>
   <arXiv:Title>Positivity for special cases of $(q,t)$-Kostka coefficients and standard
    tableaux statistics</arXiv:Title>
   <arXiv:Authors>Mike Zabrocki</arXiv:Authors>
   <arXiv:Comments>LaTEX, 37 pages, Replacement of submission with vertex operators only</arXiv:Comments>
   <arXiv:Subj-class>Combinatorics</arXiv:Subj-class>
   <arXiv:MSC-class>05E10</arXiv:MSC-class>
   <arXiv:Journal-ref>Electron. J. Combinat. 6, R41 (1999), 36pp.</arXiv:Journal-ref>
   <arXiv:Abstract>  We present two symmetric function operators $H\_3^{qt}$ and $H\_4^{qt}$ that
   have the property $H\_{3}^{qt} H\_{(2^a1^b)}[X;q,t] = H\_{(32^a1^b)}[X;q,t]$ and
   $H\_4^{qt} H\_{(2^a1^b)}[X;q,t] = H\_{(42^a1^b)}[X;q,t]$. These operators are
   generalizations of the analogous operator $H\_2^{qt}$ and also have expressions
   in terms of Hall-Littlewood vertex operators. We also discuss statistics,
   $a\_{\mu}(T)$ and $b\_{\mu}(T)$, on standard tableaux such that the $q,t$ Kostka
   polynomials are given by the sum over standard tableaux of shape $\la$,
   $K\_{\la\mu}(q,t) = \sum\_T t^{a\_{\mu}(T)} q^{b\_{\mu}(T)}$ for the case when when
   $\mu$ is two columns or of the form $(32^a1^b)$ or $(42^a1^b)$. This provides
   proof of the positivity of the $(q,t)$-Kostka coefficients in the previously
   unknown cases of $K\_{\la (32^a1^b)}(q,t)$ and $K\_{\la (42^a1^b)}(q,t)$. The
   vertex operator formulas are used to give formulas for generating functions for
   classes of standard tableaux that generalize the case when $\mu$ is two
   columns.</arXiv:Abstract>
  </arXiv:arXiv>
 </Disseminate>
```

--------------------------------

### arXiv Source File S3 URI Examples

Source: https://info.arxiv.org/help/bulk_data_s3.html

Examples of S3 URIs for accessing bulk source file tar archives.

```text
src/arXiv_src_1001_001.tar         (s3://arxiv/src/arXiv_src_1001_001.tar in s3cmd URI style)
src/arXiv_src_1001_002.tar         (s3://arxiv/src/arXiv_src_1001_002.tar)
src/arXiv_src_1001_003.tar         (s3://arxiv/src/arXiv_src_1001_003.tar)
```

--------------------------------

### Retrieving Large Result Slices

Source: https://info.arxiv.org/help/api/user-manual.html

Example of requesting a specific slice of results using start and max_results parameters.

```text
http://export.arxiv.org/api/query?search_query=all:electron&start=6000&max_results=2000
```

--------------------------------

### Initial Submission Status XML

Source: https://info.arxiv.org/help/submit_sword.html

Example XML response indicating the submission is currently in the workflow.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<deposit>
 <tracking_id>https://arxiv.org/resolve/app/10030146</tracking_id>
 <status>submitted</status>
</deposit>
```

--------------------------------

### arXiv Identifier Formats

Source: https://info.arxiv.org/help/arxiv_identifier_for_services.html

Examples of valid arXiv identifier strings using the standard prefix.

```text
arXiv:1501.00001
arXiv:0704.0001
arXiv:math/9901001
arXiv:astro-ph/9901001
```

--------------------------------

### Handling Automated Prompts

Source: https://info.arxiv.org/help/faq/mistakes.html

Example of an interactive prompt from the AutoTeX system that requires a pre-defined response file.

```text
  Would you like (P)ortrait or (L)andscape ? - answer P/L
```

--------------------------------

### Create a gzipped tar file in one step

Source: https://info.arxiv.org/help/tar.html

Combines packaging and compression into a single command to produce a .tar.gz file.

```bash
  $ tar -cvzf mystuff.tar.gz foo.tex fig1.eps fig2.eps
```

--------------------------------

### Query and Parse arXiv API Data in Python

Source: https://info.arxiv.org/help/api/examples/python_arXiv_parsing_example.txt

Uses urllib to perform a GET request and feedparser to process the resulting Atom feed. Requires the feedparser library to be installed.

```python
"""
python_arXiv_parsing_example.py

This sample script illustrates a basic arXiv api call
followed by parsing of the results using the 
feedparser python module.

Please see the documentation at 
http://export.arxiv.org/api_help/docs/user-manual.html
for more information, or email the arXiv api 
mailing list at arxiv-api@googlegroups.com.

urllib is included in the standard python library.
feedparser can be downloaded from http://feedparser.org/ .

Author: Julius B. Lucks

This is free software.  Feel free to do what you want
with it, but please play nice with the arXiv API!
"""

import urllib
import feedparser

# Base api query url
base_url = 'http://export.arxiv.org/api/query?';

# Search parameters
search_query = 'all:electron' # search for electron in all fields
start = 0                     # retreive the first 5 results
max_results = 5

query = 'search_query=%s&start=%i&max_results=%i' % (search_query,
                                                     start,
                                                     max_results)

# Opensearch metadata such as totalResults, startIndex, 
# and itemsPerPage live in the opensearch namespase.
# Some entry metadata lives in the arXiv namespace.
# This is a hack to expose both of these namespaces in
# feedparser v4.1
feedparser._FeedParserMixin.namespaces['http://a9.com/-/spec/opensearch/1.1/'] = 'opensearch'
feedparser._FeedParserMixin.namespaces['http://arxiv.org/schemas/atom'] = 'arxiv'

# perform a GET request using the base_url and query
response = urllib.urlopen(base_url+query).read()

# parse the response using feedparser
feed = feedparser.parse(response)

# print out feed information
print 'Feed title: %s' % feed.feed.title
print 'Feed last updated: %s' % feed.feed.updated

# print opensearch metadata
print 'totalResults for this query: %s' % feed.feed.opensearch_totalresults
print 'itemsPerPage for this query: %s' % feed.feed.opensearch_itemsperpage
print 'startIndex for this query: %s'   % feed.feed.opensearch_startindex

# Run through each entry, and print out information
for entry in feed.entries:
    print 'e-print metadata'
    print 'arxiv-id: %s' % entry.id.split('/abs/')[-1]
    print 'Published: %s' % entry.published
    print 'Title:  %s' % entry.title
    
    # feedparser v4.1 only grabs the first author
    author_string = entry.author
    
    # grab the affiliation in <arxiv:affiliation> if present
    # - this will only grab the first affiliation encountered
    #   (the first affiliation for the first author)
    # Please email the list with a way to get all of this information!
    try:
        author_string += ' (%s)' % entry.arxiv_affiliation
    except AttributeError:
        pass
    
    print 'Last Author:  %s' % author_string
    
    # feedparser v5.0.1 correctly handles multiple authors, print them all
    try:
        print 'Authors:  %s' % ', '.join(author.name for author in entry.authors)
    except AttributeError:
        pass

    # get the links to the abs page and pdf for this e-print
    for link in entry.links:
        if link.rel == 'alternate':
            print 'abs page link: %s' % link.href
        elif link.title == 'pdf':
            print 'pdf link: %s' % link.href
    
    # The journal reference, comments and primary_category sections live under 
    # the arxiv namespace
    try:
        journal_ref = entry.arxiv_journal_ref
    except AttributeError:
        journal_ref = 'No journal ref found'
    print 'Journal reference: %s' % journal_ref
    
    try:
        comment = entry.arxiv_comment
    except AttributeError:
        comment = 'No comment found'
    print 'Comments: %s' % comment
    
    # Since the <arxiv:primary_category> element has no data, only
    # attributes, feedparser does not store anything inside
    # entry.arxiv_primary_category
    # This is a dirty hack to get the primary_category, just take the
    # first element in entry.tags.  If anyone knows a better way to do
    # this, please email the list!
    print 'Primary Category: %s' % entry.tags[0]['term']
    
    # Lets get all the categories
    all_categories = [t['term'] for t in entry.tags]
    print 'All Categories: %s' % (', ').join(all_categories)
    
    # The abstract is in the <summary> element
    print 'Abstract: %s' %  entry.summary
```

--------------------------------

### Complete HTML integration example

Source: https://info.arxiv.org/help/myarticles.html

A full HTML structure demonstrating the placement of the author ID script, custom CSS for the feed container, and the required div element.

```html
<html>
<head>
<title>Dr. Nate's Page of accomplishments</title>
<script type="text/javascript">
<!--
var arxiv_authorid = "yourauthorid";
//--></script>
<style type="text/css">
div.arxivfeed {margin-bottom: 5px; width:700px;}
</style>
<script type="text/javascript" src="https://arxiv.org/js/myarticles.js">
</script>
</head>
<body>
<h1>Nate Rules!</h1>
<p>Stuff goes here</p>
<div id="arxivfeed"></div>
</body>
</html>
```

--------------------------------

### Process Landscape DVI Files Locally

Source: https://info.arxiv.org/help/faq/landscape.html

Command line examples for processing DVI files with the landscape flag using dvips.

```bash
$ dvips -t landscape mywidetable1.dvi
$ dvips -t landscape mywidetable2.dvi
```

--------------------------------

### Create a tar archive

Source: https://info.arxiv.org/help/tar.html

Packages multiple files into a single .tar archive using the command line.

```bash
  $ tar -cvf mystuff.tar foo.tex fig1.eps fig2.eps
```

--------------------------------

### Initialize myarticles widget for arXiv format

Source: https://info.arxiv.org/help/myarticles_ex2.html

Configure the widget by defining global variables before loading the external script. Ensure the div element with the ID 'arxivfeed' is present in the DOM to receive the output.

```html
<script type="text/javascript">
<!--
var arxiv_authorid="http://arxiv.org/a/warner_s_1";
var arxiv_format="arxiv";
var arxiv_max_entries=0;       //show all articles
var arxiv_includeSummary=1;    //show abstracts (default is 0)
var arxiv_includeComments=0;   //do not show comments (default is 1)
//--></script>
<script type="text/javascript" src="http://arxiv.org/js/myarticles.js"></script>
<div id="arxivfeed">[Loading myarticles...]</div>
```

--------------------------------

### RFC 1807 Bibliographic Record Example

Source: https://info.arxiv.org/help/oa/rfc1807.html

A complete example of a bibliographic record following the RFC 1807 specification, demonstrating field usage, continuation lines, and repeated fields.

```text
 BIB-VERSION:: CS-TR-v2.1
          ID:: OUKS//CS-TR-91-123
       ENTRY:: January 15, 1992
ORGANIZATION:: Oceanview University, Kansas, Computer Science
        TYPE:: Technical Report
    REVISION:: January 5, 1995; FTP access information added
       TITLE:: Scientific Communication must be timely
      AUTHOR:: Finnegan, James A.
     CONTACT:: Prof. J. A. Finnegan, CS Dept, Oceanview Univ,
               Oceanview, KS 54321  Tel: 913-456-7890
               AUTHOR:: Pooh, Winnie The
     CONTACT:: 100 Aker Wood
        DATE:: December 1991
       PAGES:: 48
   COPYRIGHT:: Copyright for the report (c) 1991, by J. A.
               Finnegan.  All rights reserved.  Permission is granted
               for any academic use of the report.
      HANDLE:: hdl:oceanview.electr/CS-TR-91-123
OTHER_ACCESS:: url:http://electr.oceanview.edu/CS-TR-91-123
OTHER_ACCESS:: url:ftp://electr.oceanview.edu/CS-TR-91-123
   RETRIEVAL:: send email to Finnegan@cs.ouks.edu with fax number
     KEYWORD:: Scientific Communication
 CR-CATEGORY:: D.0
 CR-CATEGORY:: C.2.2 Computer Sys Org, Communication nets, Net
               Protocols
      SERIES:: Communication
     FUNDING:: FAS
    CONTRACT:: FAS-91-C-1234
  MONITORING:: FNBO
    LANGUAGE:: English
       NOTES:: This report is the full version of the paper with
               the same title in IEEE Trans ASSP Dec 1976
ABSTRACT::
```

--------------------------------

### arXiv Comment Element

Source: https://info.arxiv.org/help/api/user-manual.html

Example of the element containing author-provided comments.

```xml
<arxiv:comment xmlns:arxiv="http://arxiv.org/schemas/atom">
   23 pages, 8 figures and 4 tables
</arxiv:comment>
```

--------------------------------

### Check DVI File Headers

Source: https://info.arxiv.org/help/mimetypes.html

Verify headers for single and multiple DVI file deliveries.

```bash
  > curl -# -I http://arxiv.org/dvi/hep-lat/9107002v1 | grep -p 'Content-[TE]'

  Content-Type: application/x-dvi
  Content-Encoding: x-gzip

  > curl -# -I http://arxiv.org/dvi/hep-lat/9107001v1 | grep -p 'Content-[TE]'

  Content-Type: application/x-eprint-tar
  Content-Encoding: x-gzip
```

--------------------------------

### Example LaTeX log output for PSTricks

Source: https://info.arxiv.org/help/faq/pstricks.html

Sample diagnostic output from a LaTeX log file showing included PSTricks macro files.

```text
...
(texmf/tex/generic/pstricks/pst-node.tex
 v97 patch 9, 1999/04/14
(texmf/tex/generic/pstricks/pstricks.tex
`PSTricks' v97 patch 10  <1999/03/24> (tvz)
(texmf/tex/generic/pstricks/pstricks.con)))
...
```

--------------------------------

### GET [tracking_uri]

Source: https://info.arxiv.org/help/submit_sword.html

Retrieves the current status of a SWORD submission in the arXiv workflow.

```APIDOC
## GET [tracking_uri]

### Description
Retrieves a short XML report on the status of a SWORD submission in the arXiv workflow.

### Method
GET

### Endpoint
[tracking_uri]

### Response
#### Success Response (200)
- **deposit** (XML) - The root element containing the status report.
- **tracking_id** (string) - The URI used to track the submission.
- **status** (string) - The current status of the submission (submitted, published, on hold, incomplete, or unknown).
- **arxiv_id** (string) - Optional; the final arXiv identifier if the status is published.

#### Response Example
<?xml version="1.0" encoding="UTF-8"?>
<deposit>
 <tracking_id>https://arxiv.org/resolve/app/10030146</tracking_id>
 <status>published</status>
 <arxiv_id>1003.9876</arxiv_id>
</deposit>
```

--------------------------------

### Submit article via SWORD/APP

Source: https://info.arxiv.org/help/submit_sword.html

Executes a media deposit to the physics collection with an MD5 checksum.

```bash
$ ./media-deposit.pl --collection=physics --filename=submission.zip --verbose --md5
Enter username for "SWORD@arXiv": demouser
Password for demouser:
```

--------------------------------

### GET /openurl-resolver

Source: https://info.arxiv.org/help/openurl.html

The arXiv OpenURL resolver endpoint for resolving arXiv identifiers.

```APIDOC
## GET /openurl-resolver

### Description
A resolver service that redirects requests to the appropriate abstract page on arXiv based on the provided identifier.

### Method
GET

### Endpoint
http://arXiv.org/openurl-resolver

### Parameters
#### Query Parameters
- **id** (string) - Optional - Used for OpenURL v0.1 requests (e.g., oai:arXiv.org:cs.DL/0106057).
- **rft_id** (string) - Optional - Used for OpenURL v1.0 requests.
- **url_ver** (string) - Optional - Used for OpenURL v1.0 requests (e.g., Z39.88-2004).
```

--------------------------------

### arXiv DOI Element

Source: https://info.arxiv.org/help/api/user-manual.html

Example of the element used to provide a Digital Object Identifier.

```xml
<arxiv:doi xmlns:arxiv="http://arxiv.org/schemas/atom">
   10.1529/biophysj.104.047340
</arxiv:doi>
```

--------------------------------

### List of PSTricks distribution files

Source: https://info.arxiv.org/help/faq/pstricks.html

A list of common PSTricks macro files available in the distribution.

```text
dvipsone.con  pst-char.sty  pst-ghsb.tex  pst-plot.sty  pst-tree.tex
multido.sty   pst-char.tex  pst-ghsb.tex  pst-plot.tex  pstricks.bug
multido.tex   pst-coil.sty  pst-gr3d.tex  pst-poly.sty  pstricks.con
palette.sty   pst-coil.tex  pst-gr3d.tex  pst-poly.tex  pstricks.sty
pst-3d.sty    pst-eps.sty   pst-grad.tex  pst-slpe.sty  pstricks.tex
pst-3d.tex    pst-eps.tex   pst-key.sty   pst-slpe.tex  textures.con
pst-all.sty   pst-fill.sty  pst-key.tex   pst-text.sty  vtex.con
pst-blur.sty  pst-fill.tex  pst-node.sty  pst-text.tex
pst-blur.tex  pst-ghsb.sty  pst-node.tex  pst-tree.sty
```

--------------------------------

### arXiv Affiliation Element

Source: https://info.arxiv.org/help/api/user-manual.html

Example of an affiliation subelement within an Atom author block.

```xml
<author>
   <name>G. G. Kacprzak</name>
   <arxiv:affiliation xmlns:arxiv="http://arxiv.org/schemas/atom">NMSU</arxiv:affiliation>
</author>
```

--------------------------------

### RSS Item GUID Element

Source: https://info.arxiv.org/help/rss_specifications.html

A unique identifier for the article, with isPermaLink set to false.

```xml
<guid isPermaLink="false">oai:arXiv.org:2203.01250v3</guid>
```

--------------------------------

### Testing Input Files Locally

Source: https://info.arxiv.org/help/faq/mistakes.html

Command to test an .inp response file against a TeX source file on a local machine.

```bash
  $ cat filename.inp | tex filename.tex
```

--------------------------------

### arXiv Journal Reference Element

Source: https://info.arxiv.org/help/api/user-manual.html

Example of the element used to provide journal reference information.

```xml
<arxiv:journal_ref xmlns:arxiv="http://arxiv.org/schemas/atom">
   Eur.Phys.J. C31 (2003) 17-29
</arxiv:journal_ref>
```

--------------------------------

### LaTeX document with hyperref

Source: https://info.arxiv.org/help/hypertex/index.html

A sample LaTeX file demonstrating the use of hyperref for internal and external links.

```LaTeX
\documentclass[11pt]{article}
\usepackage{hyperref}

\begin{document}
This is the first page, with a
\hyperlink{page2}{link to a word on the second page}.

\newpage

This is the \hypertarget{page2}{second} page, with a link to an
\href{https://arxiv.org}{external document}.

\end{document}
```

--------------------------------

### Media Deposit Script Usage

Source: https://info.arxiv.org/help/submit_sword.html

Commands for executing the media-deposit.pl script and viewing its documentation.

```bash
$ ./media-deposit.pl --filename=<...> --collection=<...>
```

```bash
$ perldoc media-deposit.pl
```

--------------------------------

### GET /sword-app/edit/{id}

Source: https://info.arxiv.org/help/submit_sword.html

Retrieves the current metadata wrapper for an existing paper to facilitate modifications.

```APIDOC
## GET /sword-app/edit/{id}

### Description
Retrieves the existing atom entry for a paper, which can then be modified and submitted back via a PUT request.

### Method
GET

### Endpoint
https://arxiv.org/sword-app/edit/{id}
```

--------------------------------

### GET /dienst/Repository/1.0/Disseminate/{identifier}/%23arXiv/xml

Source: https://info.arxiv.org/help/oa/arXiv_meta_format.html

Retrieves the metadata for a specific arXiv record in XML format.

```APIDOC
## GET /dienst/Repository/1.0/Disseminate/{identifier}/%23arXiv/xml

### Description
Retrieves the unparsed and uninterpreted meta-data for a specific arXiv record. The response is returned as an XML document.

### Method
GET

### Endpoint
/dienst/Repository/1.0/Disseminate/{identifier}/%23arXiv/xml

### Parameters
#### Path Parameters
- **identifier** (string) - Required - The internal paper identifier (e.g., arXiv:math.CO/9901016)

### Response
#### Success Response (200)
- **Content-type** (string) - text/xml
- **Body** (XML) - An XML structure containing fields such as Id, Title, Authors, Abstract, Comments, Subj-class, MSC-class, Report-no, and Journal-ref.

#### Response Example
<?xml version="1.0" encoding="UTF-8"?>
 <Disseminate version="1.0">
  <arXiv:arXiv xmlns:arXiv="http://arXiv.org/help/oa/arXiv_meta_format">
   <arXiv:Id>math/9901016</arXiv:Id>
   <arXiv:Title>Positivity for special cases of $(q,t)$-Kostka coefficients and standard tableaux statistics</arXiv:Title>
   <arXiv:Authors>Mike Zabrocki</arXiv:Authors>
   <arXiv:Abstract>We present two symmetric function operators...</arXiv:Abstract>
  </arXiv:arXiv>
 </Disseminate>
```
Tokens:
Raw