Skip to content

CITATION.md

Latest commit

 

History

History
104 lines (78 loc) · 3.56 KB

CITATION.md

File metadata and controls

104 lines (78 loc) · 3.56 KB

File: CITATION.md

Citation & Reference Policy (STAG)

This repository is intended to be credible to engineers. Credibility requires:

  • primary sources where possible,
  • vendor datasheets for components,
  • clear separation of what is measured vs assumed,
  • and strict avoidance of copying copyrighted text.

This file defines how we cite and how we keep references clean.

1) What must be cited

You must cite a source when you:

  • reference a known thermoacoustic concept, equation set, or design guideline beyond basic definitions,
  • propose performance ranges that are not directly measured in this repo,
  • specify a component capability (bandwidth, accuracy, operating temperature, pressure rating),
  • claim a material property or a standard (outgassing, vacuum compatibility, etc.),
  • reference industry practices (e.g., measurement methods, calibration standards).

2) What counts as an acceptable source

Preferred order:

  1. Peer-reviewed papers and textbooks (primary technical sources)
  2. Government/standards documents (NASA, NIST, ISO, IEC, etc.)
  3. Manufacturer datasheets (for parts and sensors)
  4. Reputable technical articles (only if primary sources are unavailable)

Avoid:

  • unsourced blog claims
  • marketing-only pages without numbers or datasheets
  • “mystery” forum posts unless they link to primary sources

3) How to cite in this repo

  • Use a short, consistent format in markdown:
    • Author(s), Title, Venue/Publisher, Year, DOI/URL (if available)
  • If the citation supports a specific statement, place it immediately after that statement.

Example:

Thermoacoustic engines can convert a temperature gradient into acoustic power under appropriate impedance conditions.
— Swift, Thermoacoustics: A Unifying Perspective for Some Engines and Refrigerators, 2002.

4) Do not copy copyrighted text

  • Do not paste large sections from papers, books, or datasheets.
  • Do not paste vendor drawings unless explicitly permitted.
  • Summarize in your own words and cite the source.

Rule of thumb:

  • If you need the exact text, quote only a short excerpt and keep it minimal.
  • Prefer paraphrase + citation.

5) Data integrity and “no fantasy numbers”

  • Any numeric claim should be one of:
    • measured in this repo (with dataset + method),
    • a stated assumption (explicitly labeled),
    • or a cited value (with source and context).
  • If you can’t cite it and you didn’t measure it, label it as an assumption and provide a test plan to verify.

6) Vendor component references

When adding part numbers:

  • include a linkable datasheet reference (manufacturer preferred)
  • record key specs used:
    • temperature rating,
    • pressure rating,
    • sensor bandwidth,
    • accuracy/tolerance,
    • electrical ratings.

If a vendor does not provide a real datasheet, do not use the part as a baseline recommendation.

7) Reference hygiene

  • Keep a running list of references in docs/REFERENCES.md.
  • When a doc section relies on a reference, add it to docs/REFERENCES.md and cite it in the doc.
  • Avoid “citation dumping.” Cite only what supports the claim.

8) Review standard (engineer trust gate)

A reviewer should be able to:

  • trace each key assertion to either (a) measurement, (b) assumption, or (c) citation,
  • reproduce the model outputs from models/,
  • and reproduce the test workflow from test/.

If that chain breaks, the repo loses credibility.

9) Update policy

If a new reference contradicts an old one:

  • keep both in docs/REFERENCES.md,
  • and update the affected section with a clear note explaining the difference.