Citation

If you use Syren in academic work, please cite it.

How to cite

The repository includes a CITATION.cff file. On GitHub, use the Cite this repository button on the repository page to get a formatted citation (BibTeX or APA) generated from that file. The citation records the title, author, version, license, and repository URL.

Cite the specific version you used, so the reference points at the exact code that produced your results. The version is in CITATION.cff and in the crate metadata.

What to include

Alongside the software citation, report the run provenance for any result you present — version, features, seed, configuration, and input data — as described in run provenance. The software citation says which tool; the provenance says which run.

DOI

A DOI is minted for public, non-candidate releases. Until then, cite the version and repository URL. When a DOI is available it will be recorded in CITATION.cff and can be cited in place of the repository URL.