energy_methods.references#
One citation catalogue for the repository and generated analysis reports.
The thesis inspired the project and its early work. Later additions have their own sources. A catalogue entry records where a work is used; its presence alone does not mean a particular run used its data or algorithm. Sources marked as background are not implementations.
- class energy_methods.references.Reference(id, title, authors, year, doi, url, kind, role, used_by, note, publication='', volume='', issue='', pages='', institution='', verified_at='2026-10-29')[source]#
Bases:
objectVerified bibliographic metadata, with a transparent implementation role.
- Parameters:
id (str)
title (str)
authors (tuple[str, ...])
year (int | None)
doi (str | None)
url (str)
kind (str)
role (str)
used_by (tuple[str, ...])
note (str)
publication (str)
volume (str)
issue (str)
pages (str)
institution (str)
verified_at (str)
- id: str#
- title: str#
- authors: tuple[str, ...]#
- year: int | None#
- doi: str | None#
- url: str#
- kind: str#
- role: str#
- used_by: tuple[str, ...]#
- note: str#
- publication: str#
- volume: str#
- issue: str#
- pages: str#
- institution: str#
- verified_at: str#
- property key: str#
BibTeX/citation key; identical to the stable catalogue ID.
- energy_methods.references.get_references(ids=None)[source]#
Select known IDs, retaining the thesis first as project context.
Unknown IDs fail instead of silently losing attribution. The full catalogue includes optional-source and background entries; consult
roleandnotebefore describing a source as used by an individual analysis run.- Parameters:
ids (Iterable[str] | None)
- Return type:
tuple[Reference, …]
- energy_methods.references.references_markdown(ids=None)[source]#
Render complete citations and their use without fetching external content.
- Parameters:
ids (Iterable[str] | None)
- Return type:
str