Skip to content

Index

subsurfaceio.references

Bibliographic catalog used in model References: lists.

Look up a record and format a short citation:

from subsurfaceio.references import reference_registry

citation = reference_registry['terzaghi1943theoretical'].as_citation

Classes:

Name Description
Reference

Bibliographic record for a published source.
References

Catalog of named Reference records.

Attributes:

Name Type Description
reference_registry References

reference_registry module-attribute 

reference_registry: References = References.model_validate(
    references
)

Reference pydantic-model

Bases: BaseModel

Bibliographic record for a published source.

Fields:

ID pydantic-field 

ID: str | None = None

as_citation property 

as_citation: str

Short author-year-title citation string.

author pydantic-field 

author: str | None = None

author_simplified pydantic-field 

author_simplified: str | None = None

doi pydantic-field 

doi: str | None = None

is_corporate_author pydantic-field 

is_corporate_author: bool = False

isbn pydantic-field 

isbn: str | None = None

link: str

DOI, ISBN, URL, or Google Scholar search link for this record.

title pydantic-field 

title: str | None = None

url pydantic-field 

url: str | None = None

year pydantic-field 

year: int | None = None

References

Bases: RootModel[dict[str, Reference]]

Catalog of named Reference records.

Methods:

Name Description
items
keys
values

items 

items()

keys 

keys()

values 

values()