argopy.related.doi_snapshot.DOIrecord

class DOIrecord(doi: str = '10.17882/42182', hashtag: str | None = None, fs: httpstore | None = None, autoload: bool = True, api_root: str = 'https://www.seanoe.org/api/')

Meta-data holder for an Argo GDAC snapshot DOI record

This is a low-level class that is not intended to be instantiated directly.

Please use the ArgoDOI instead.

Examples

API description

d = DOIrecord()
d = DOIrecord('42182')
d = DOIrecord('42182#103075')
d = DOIrecord(hashtag='103075')
d = DOIrecord(hashtag='103088')

d.doi
d.dx
d.isvalid
d.date
d.network
d.data
d.file

__init__(doi: str = '10.17882/42182', hashtag: str | None = None, fs: httpstore | None = None, autoload: bool = True, api_root: str = 'https://www.seanoe.org/api/')

Methods

__init__([doi, hashtag, fs, autoload, api_root])
from_dict(d)	Load DOI record data from a dictionary
isvalid()
load([cache])	Load DOI record data from API call
search(**kwargs)

Attributes

data	DOI record meta-data holder
date	Date associated with the DOI record
doi	DOI component (without hashtag)
dx	DOI url
file	Return a pretty list of files properties associated with this DOI
hashtag	Hashtag of the full doi
network	Network of the Argo data pointed by the DOI
root
uri	url to API call to retrieve DOI data