Skip to content

Commit

Permalink
Merge pull request #22 from cfs-energy/add_pdf
Browse files Browse the repository at this point in the history
docs: add prd changes pdf
  • Loading branch information
tbody-cfs authored Dec 13, 2023
2 parents 2325f2e + 8b3dd39 commit a396279
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
Binary file added docs/doc_sources/Changes-to-SPARC-PRD.pdf
Binary file not shown.
5 changes: 4 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@ Welcome to cfspopcon's documentation!
POPCONs (Plasma OPerating CONtours) is a tool developed to explore the performance and constraints of tokamak designs based on 0D scaling laws, model plasma kinetic profiles, and physics assumptions on the properties and behavior of the core plasma.

POPCONs was initially described in :cite:`prd` where it was applied to the design of the SPARC tokamak.
Further, :cite:`prd` also introduced the SPARC Primary Reference Discharge (PRD) defining the highest fusion gain achievable on SPARC.
Since that paper was released, the design point has been refined and the latest design point is now available as :code:`example_cases/SPARC_PRD`, which is covered in the :ref:`Getting Started <gettingstarted>` guide.
A document explaining the changes between the SPARC Physics Basis and the current version are detailed in :download:`Changes-to-SPARC-PRD.pdf<doc_sources/Changes-to-SPARC-PRD.pdf>`.

To start generating your fist plasma operating contours with cfspopcon, head over to the :ref:`Getting Started <gettingstarted>` guide.

A usefull resource is our :ref:`Physics Glossary <physics_glossary>` which lists all input and output variables, including definitions and citations for formulas where relevant.
A useful resource is our :ref:`Physics Glossary <physics_glossary>` which lists all input and output variables, including definitions and citations for formulas where relevant.

If you are interested in how to setup a development environment to make changes to cfspopcon, we suggest you checkout the :ref:`Developer's Guide <devguide>`.

Expand Down

0 comments on commit a396279

Please sign in to comment.