From f9f2472cd27bf594067f928d69799015bec8c492 Mon Sep 17 00:00:00 2001 From: Philipp Jurasic Date: Fri, 15 Nov 2024 15:37:21 +0100 Subject: [PATCH] use Citations.cff in readme --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b9802d8d..bf4b6b28 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ -# The Stepped Pressure Equilibrium Code (SPEC) +# ![SPEC logo](SPEC_97x55.png) The Stepped Pressure Equilibrium Code -A BibTex file is available: [spec_refs.bib](https://raw.githubusercontent.com/PrincetonUniversity/SPEC/master/spec_refs.bib). -* There is also a [brief description of SPEC](http://theory.pppl.gov/research/research.php?rid=10#h5) - on the Princeton Plasma Physics Laboratory [Theory Department website](http://theory.pppl.gov/). -* An overview of the algorithm is given in a [Flow Chart](https://princetonuniversity.github.io/SPEC/docs/SPEC_flowchart.pdf). -* Please direct questions/suggestions to [Stuart Hudson](mailto:shudson@pppl.gov?subject=spec). -* Online documentation for SPEC is available on [Github pages](https://princetonuniversity.github.io/SPEC/). +If you use SPEC in your research, please cite it appropriately using the "Cite this repository" button on the right of the [SPEC GitHub Repository](https://github.com/PrincetonUniversity/SPEC) or the [CITATION.cff](https://github.com/PrincetonUniversity/SPEC/blob/master/CITATION.cff) file. + +There is a [brief description of SPEC](http://theory.pppl.gov/research/research.php?rid=10#h5) on the Princeton Plasma Physics Laboratory [Theory Department website](http://theory.pppl.gov/). An overview of the algorithm is given in a [Flow Chart](https://princetonuniversity.github.io/SPEC/docs/SPEC_flowchart.pdf). + +Please direct questions/suggestions to [Stuart Hudson](mailto:shudson@pppl.gov?subject=spec). + +## Installation +Instructions for compiling and testing SPEC are in [compilation_instructions.md](https://github.com/PrincetonUniversity/SPEC/blob/master/compilation_instructions.md). + +## Documentation +Online documentation for SPEC is available on [Github pages](https://princetonuniversity.github.io/SPEC/). A PDF version of this manual is available in [SPEC_manual.pdf](https://princetonuniversity.github.io/SPEC/SPEC_manual.pdf). -* Instructions for compiling and testing SPEC are in [compilation_instructions.md](https://github.com/PrincetonUniversity/SPEC/blob/master/compilation_instructions.md). + +