Research software
Citation and reproducibility
Use this page to publish the preferred Struphy citation and help readers reproduce the exact software environment behind a result.
BibTeX template
Recommended for papers and LaTeX bibliographies.
@software{struphy_TODO_YEAR,
author = {TODO: Struphy authors or collaboration},
title = {Struphy: TODO preferred software title},
version = {TODO: release used},
year = {TODO: publication year},
doi = {TODO: archival DOI},
url = {https://github.com/struphy-hub/struphy}
}CITATION.cff template
Machine-readable citation metadata for GitHub and reference managers.
cff-version: 1.2.0
message: "If you use Struphy, please cite it using this metadata."
title: "TODO: preferred Struphy software title"
type: software
authors:
- family-names: "TODO"
given-names: "TODO"
version: "TODO"
date-released: "TODO: YYYY-MM-DD"
doi: "TODO"
repository-code: "https://github.com/struphy-hub/struphy"
license: MITReproducibility checklist
- Struphy version or exact Git commit
- Python version and operating system
- Complete simulation configuration
- Model, domain, equilibrium, and perturbation names
- Random seed and initial-condition data
- MPI process count and relevant hardware details
- Post-processing scripts and plotting parameters
- Archived input, output, and environment files with a persistent DOI