ads.services.export¶

The ADS export document service.

Functions

`aastex`(*iterable[, journal_format, sort])	Return a citation string in AASTeX format.
`ads`(*iterable[, sort])	Return a citation string in ADS (generic tagged) format
`bibtex`(*iterable[, max_author, ...])	Return a citation string in BibTeX format.
`bibtexabs`(*iterable[, max_author, ...])	Return a citation string in BibTeX + abstract format.
`csl`(*iterable, style, format[, sort, ...])	Return a citation string in a custom style and format.
`custom`(*iterable, format)	Return a citation string in a custom format.
`dcxml`(*iterable[, sort])	Return a citation string in Dublin Core (DC) XML format.
`endnote`(*iterable[, sort])	Return a citation string in EndNote format.
`icarus`(*iterable[, sort])	Return a citation string in Icarus format.
`ieee`(*iterable[, sort])	Return a citation string in IEEE export (Unicode-encoded).
`medlars`(*iterable[, sort])	Return a citation string in MEDLARS format.
`mnras`(*iterable[, sort])	Return a citation string in Monthly Notices of the Royal Astronomical Society format.
`procite`(*iterable[, sort])	Return a citation string in ProCite format.
`refabsxml`(*iterable[, sort])	Return a citation string in REFABS-XML format.
`refworks`(*iterable[, sort])	Return a citation string in RefWorks format.
`refxml`(*iterable[, sort])	Return a citation string in REF-XML format.
`ris`(*iterable[, sort])	Return a citation string in RIS (Refman) format.
`soph`(*iterable[, sort])	Return a citation string in Solar Physics (SoPh) format.
`votable`(*iterable[, sort])	Return a citation string in VOTables format.

ads.services.export.ads(*iterable, sort=None) → str[source]¶

Return a citation string in ADS (generic tagged) format

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.bibtex(*iterable, max_author=10, author_cutoff=200, key_format=None, journal_format=1, sort=None) → str[source]¶

Return a citation string in BibTeX format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
max_author – [optional] The maximum number of authors displayed. The default value for {obj}`ads.services.export.bibtex` and {obj}`ads.services.export.bibtexabs` are different, because the defaults for each end point are different.
key_format –
[optional] Customize bibtex for reference keys using some combination of authors’ last name(s), publication year, journal, and bibcode. The user can pick the key generation algorithm by specifying a custom format for it.

For example:

The user can specify %zm to enumerate keys (one character alphabet) if duplicate keys get created. Note that if enumeration specifer is not included, then the export service does not enumerate the keys, even if duplicate keys are found.
journal_format –
[optional] An integer flag to decide on the format of the journal name:
- 1 indicates to use AASTeX macros if there are any (default), otherwise full journal name is exported.
- 2 indicates to use journal abbreviations,
- 3 indicates to use full journal name.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.bibtexabs(*iterable, max_author=0, author_cutoff=200, key_format=None, journal_format=1, sort=None) → str[source]¶

Return a citation string in BibTeX + abstract format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
max_author – [optional] The maximum number of authors displayed. The default value for {obj}`ads.services.export.bibtex` and {obj}`ads.services.export.bibtexabs` are different, because the defaults for each end point are different.
key_format –
[optional] Customize bibtex for reference keys using some combination of authors’ last name(s), publication year, journal, and bibcode. The user can pick the key generation algorithm by specifying a custom format for it.

For example: ```

Accomazzi:2019 – %1H:%Y Accomazzi:2019:AAS – %1H:%Y:%q Accomazzi2019 – %1H%Y Accomazzi2019AAS – %1H%Y%q AccomazziKurtz2019 – %2H%Y

```

The user can specify %zm to enumerate keys (one character alphabet) if duplicate keys get created. Note that if enumeration specifer is not included, then the export service does not enumerate the keys, even if duplicate keys are found.
journal_format –
[optional] An integer flag to decide on the format of the journal name:
- 1 indicates to use AASTeX macros if there are any (default), otherwise full journal name is exported.
- 2 indicates to use journal abbreviations,
- 3 indicates to use full journal name.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.endnote(*iterable, sort=None) → str[source]¶

Return a citation string in EndNote format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.medlars(*iterable, sort=None) → str[source]¶

Return a citation string in MEDLARS format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.procite(*iterable, sort=None) → str[source]¶

Return a citation string in ProCite format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.refworks(*iterable, sort=None) → str[source]¶

Return a citation string in RefWorks format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.ris(*iterable, sort=None) → str[source]¶

Return a citation string in RIS (Refman) format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.aastex(*iterable, journal_format=1, sort=None) → str[source]¶

Return a citation string in AASTeX format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
journal_format –
[optional] An integer flag to decide on the format of the journal name:
- 1 indicates to use AASTeX macros if there are any (default), otherwise full journal name is exported.
- 2 indicates to use journal abbreviations,
- 3 indicates to use full journal name.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.icarus(*iterable, sort=None) → str[source]¶

Return a citation string in Icarus format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.mnras(*iterable, sort=None) → str[source]¶

Return a citation string in Monthly Notices of the Royal Astronomical Society format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.soph(*iterable, sort=None) → str[source]¶

Return a citation string in Solar Physics (SoPh) format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.dcxml(*iterable, sort=None) → str[source]¶

Return a citation string in Dublin Core (DC) XML format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.refxml(*iterable, sort=None) → str[source]¶

Return a citation string in REF-XML format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.refabsxml(*iterable, sort=None) → str[source]¶

Return a citation string in REFABS-XML format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.votable(*iterable, sort=None) → str[source]¶

Return a citation string in VOTables format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.csl(*iterable, style, format, sort=None, journal_format=None) → str[source]¶

Return a citation string in a custom style and format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
style –
The name of the style to use. This can be one of:
- aastex
- icarus
- mnras
- soph
- aspc
- apsj
- aasj
- ieee
format –
An integer representing the format to use. This can be one of:
- 1 for Unicode
- 2 for HTML
- 3 for LaTeX
journal_format –
[optional] An integer flag to decide on the format of the journal name:
- 1 indicates to use AASTeX macros if there are any (default), otherwise full journal name is exported.
- 2 indicates to use journal abbreviations,
- 3 indicates to use full journal name.
This keyword is only used when one of the following style``s is used: ``aastex, aspc, and aasj.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().

ads.services.export.custom(*iterable, format) → str[source]¶

Return a citation string in a custom format.

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
format – A custom citation format. For example: “%ZEncoding:latexbibitem[] %l %T (%Y) %q, %V, %p-%P.”

ads.services.export.ieee(*iterable, sort=None) → str[source]¶

Return a citation string in IEEE export (Unicode-encoded).

Parameters

iterable – An iterable that contains: ads.Document objects, ads.Library objects, or strings of bibcodes.
sort – [optional] The sorting to apply to the results. This can be None (no sort), a string like “citation_count desc”), or something like ads.Document.pubdate.desc().