Skip to content

Commit

Permalink
use Citations.cff in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
missing-user committed Nov 15, 2024
1 parent c07be3c commit f9f2472
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:[email protected]?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:[email protected]?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).


0 comments on commit f9f2472

Please sign in to comment.