Merge pull request #155 from BlackHolePerturbationToolkit/citation_update

Update PAPERS.bib to include last paper

Author: cchapmanbird

CITATION.cff

@@ -58,6 +58,51 @@ keywords:
   - Waveform
 license: MIT
 references:
+  - abbreviation: "Chapman-Bird:2025xtd"
+    authors:
+      - family-names: Chapman-Bird
+        given-names: Christian E. A.
+      - family-names: Speri
+        given-names: Lorenzo
+      - family-names: Nazipak
+        given-names: Zachary
+      - family-names: Burke
+        given-names: Ollie
+      - family-names: Katz
+        given-names: Michael L.
+      - family-names: Santini
+        given-names: Alessandro
+      - family-names: Kejriwal
+        given-names: Shubham
+      - family-names: Lynch
+        given-names: Philip
+      - family-names: Mathews
+        given-names: Josh
+      - family-names: Khalvati
+        given-names: Hassan
+      - family-names: Thompson
+        given-names: Jonathan E.
+      - family-names: Isoyama
+        given-names: Soichiro
+      - family-names: Hughes
+        given-names: Scott A.
+      - family-names: Warburton
+        given-names: Niels
+      - family-names: Chua
+        given-names: Alvin J. K.
+      - family-names: Pigou
+        given-names: Maxime
+    doi: 10.48550/arXiv.2506.09470
+    year: 2025
+    month: 6
+    title: >-
+      The Fast and the Frame-Dragging: Efficient waveforms for asymmetric-mass
+      eccentric equatorial inspirals into rapidly-spinning black holes
+    identifiers:
+      - type: other
+        value: 'arXiv:gr-qc/2506.09470'
+        description: arXiv preprint of this article
+    type: article
   - abbreviation: "Chua:2020stf"
     authors:
       - family-names: Chua

PAPERS.bib

@@ -42,3 +42,13 @@ @article{Speri:2023jte
     volume = "9",
     year = "2024"
 }
+
+@article{Chapman-Bird:2025xtd,
+    author = "Chapman-Bird, Christian E. A. and others",
+    title = "{The Fast and the Frame-Dragging: Efficient waveforms for asymmetric-mass eccentric equatorial inspirals into rapidly-spinning black holes}",
+    eprint = "2506.09470",
+    archivePrefix = "arXiv",
+    primaryClass = "gr-qc",
+    month = "6",
+    year = "2025"
+}

src/few/cmd/citations.py

@@ -12,9 +12,19 @@ def main():
         prog="few_citations",
         description="Export the citations associated to a given module of the FastEMRIWaveforms package",
     )
-    parser.add_argument("module")
+    parser.add_argument("module", nargs="?")
+    parser.add_argument(
+        "--all", action="store_true", dest="all", help="Print all available citations"
+    )
+
     args = parser.parse_args(sys.argv[1:])
 
+    arg_all: bool = args.all
+
+    if arg_all:
+        print(Citable.all_citations())  # noqa T201
+        return
+
     few_class: str = args.module
 
     if not few_class.startswith("few."):

src/few/utils/citations.py

@@ -10,21 +10,22 @@
 
 import abc
 import enum
-from typing import List, Optional, Union
+from typing import Iterable, List, Optional, Union
 
 from pydantic import BaseModel
 
 from few.utils.exceptions import InvalidInputFile
 
 
+def _hyphen_replace(field: str) -> str:
+    return field.replace("_", "-")
+
+
 class HyphenUnderscoreAliasModel(BaseModel):
     """Pydantic model were hyphen replace underscore in field names."""
 
     class Config:
-        def hyphen_replace(field: str) -> str:
-            return field.replace("_", "-")
-
-        alias_generator = hyphen_replace
+        alias_generator = _hyphen_replace
         extra = "ignore"
         frozen = True
 
@@ -74,7 +75,7 @@ class ArticleReference(ReferenceABC):
     abbreviation: str
     authors: List[Author]
     title: str
-    journal: str
+    journal: Optional[str] = None
     year: int
     month: Optional[int] = None
     issue: Optional[int] = None
@@ -97,6 +98,9 @@ def arxiv_preprint(self) -> Optional[ArxivIdentifier]:
           - The arXiv reference (e.g. "arxiv:1912.07609")
           - The primary class followed by '/' and the reference (e.g. "arxiv:gr-qc/1912.07609")
         """
+        if self.identifiers is None:
+            return None
+
         for identifier in self.identifiers:
             if identifier.type != "other":
                 continue
@@ -134,7 +138,8 @@ def format_line(key: str, value: str, format: str = line_format) -> str:
             )
         )
         lines.append(format_line("title", "{" + self.title + "}"))
-        lines.append(format_line("journal", self.journal))
+        if self.journal is not None:
+            lines.append(format_line("journal", self.journal))
         lines.append(format_line("year", str(self.year)))
         if self.month is not None:
             lines.append(format_line("month", str(self.month)))
@@ -181,6 +186,9 @@ class SoftwareReference(ReferenceABC):
     @property
     def doi(self) -> Optional[str]:
         """Return the first DOI in identifiers if any"""
+        if self.identifiers is None:
+            return None
+
         for identifier in self.identifiers:
             if identifier.type == "doi":
                 return identifier.value
@@ -238,6 +246,7 @@ class REFERENCE(enum.Enum):
     AAK2 = "Chua:2017ujo"
     AK = "Barack:2003fp"
     FD = "Speri:2023jte"
+    KERR_ECC_EQ = "Chapman-Bird:2025xtd"
 
     def __str__(self) -> str:
         return str(self.value)
@@ -255,6 +264,9 @@ def get(self, key: Union[str, REFERENCE]) -> Reference:
         """Return a Reference object from its key."""
         return self.registry[key if isinstance(key, str) else key.value]
 
+    def all(self) -> Iterable[Reference]:
+        return self.registry.values()
+
 
 def build_citation_registry() -> CitationRegistry:
     """Read the package CITATION.cff and build the corresponding registry."""
@@ -307,7 +319,12 @@ def to_reference(ref_dict) -> Reference:
     return CitationRegistry(**references, **{cff["title"]: to_reference(cff)})
 
 
-COMMON_REFERENCES = [REFERENCE.FEW, REFERENCE.LARGER_FEW, REFERENCE.FEW_SOFTWARE]
+COMMON_REFERENCES = [
+    REFERENCE.KERR_ECC_EQ,
+    REFERENCE.FEW,
+    REFERENCE.LARGER_FEW,
+    REFERENCE.FEW_SOFTWARE,
+]
 
 
 class Citable:
@@ -320,18 +337,29 @@ def citation(cls) -> str:
         """Return the module references as a printable BibTeX string."""
         references = cls.module_references()
 
-        if Citable.registry is None:
-            from few import get_logger
+        registry = cls._get_registry()
 
-            get_logger().debug("Building the Citation Registry from CITATION.cff")
-            Citable.registry = build_citation_registry()
+        bibtex_entries = [registry.get(str(key)).to_bibtex() for key in references]
+        return "\n\n".join(bibtex_entries)
+
+    @classmethod
+    def all_citations(cls) -> str:
+        """Return all the citations from the registry as printable BibTeX string"""
+        registry = cls._get_registry()
 
-        bibtex_entries = [
-            Citable.registry.get(str(key)).to_bibtex() for key in references
-        ]
+        bibtex_entries = [entry.to_bibtex() for entry in registry.all()]
         return "\n\n".join(bibtex_entries)
 
     @classmethod
-    def module_references(cls) -> List[Union[REFERENCE, str]]:
+    def module_references(cls) -> Iterable[Union[REFERENCE, str]]:
         """Method implemented by each class to define its list of references"""
         return COMMON_REFERENCES
+
+    @classmethod
+    def _get_registry(cls) -> CitationRegistry:
+        if Citable.registry is None:
+            from few import get_logger
+
+            get_logger().debug("Building the Citation Registry from CITATION.cff")
+            Citable.registry = build_citation_registry()
+        return Citable.registry