1+
2+
3+ <!DOCTYPE html>
4+ < html class ="writer-html5 " lang ="en " data-content_root ="./ ">
5+ < head >
6+ < meta charset ="utf-8 " /> < meta name ="viewport " content ="width=device-width, initial-scale=1 " />
7+
8+ < meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
9+ < title > Using GACODE — GACODE</ title >
10+ < link rel ="stylesheet " type ="text/css " href ="_static/pygments.css?v=03e43079 " />
11+ < link rel ="stylesheet " type ="text/css " href ="_static/css/theme.css?v=e59714d7 " />
12+ < link rel ="stylesheet " type ="text/css " href ="_static/contentui.css " />
13+
14+
15+ < link rel ="shortcut icon " href ="_static/favicon.ico "/>
16+ < script src ="_static/jquery.js?v=5d32c60e "> </ script >
17+ < script src ="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c "> </ script >
18+ < script src ="_static/documentation_options.js?v=5929fcd5 "> </ script >
19+ < script src ="_static/doctools.js?v=9bcbadda "> </ script >
20+ < script src ="_static/sphinx_highlight.js?v=dc90522c "> </ script >
21+ < script src ="_static/contentui.js "> </ script >
22+ < script src ="_static/js/theme.js "> </ script >
23+ < link rel ="index " title ="Index " href ="genindex.html " />
24+ < link rel ="search " title ="Search " href ="search.html " />
25+ < link rel ="next " title ="Prebuilt Environments " href ="setup.html " />
26+ < link rel ="prev " title ="The General Atomics GACODE Suite " href ="index.html " />
27+ </ head >
28+
29+ < body class ="wy-body-for-nav ">
30+ < div class ="wy-grid-for-nav ">
31+ < nav data-toggle ="wy-nav-shift " class ="wy-nav-side ">
32+ < div class ="wy-side-scroll ">
33+ < div class ="wy-side-nav-search " >
34+
35+
36+
37+ < a href ="index.html " class ="icon icon-home ">
38+ GACODE
39+ </ a >
40+ < div role ="search ">
41+ < form id ="rtd-search-form " class ="wy-form " action ="search.html " method ="get ">
42+ < input type ="text " name ="q " placeholder ="Search docs " aria-label ="Search docs " />
43+ < input type ="hidden " name ="check_keywords " value ="yes " />
44+ < input type ="hidden " name ="area " value ="default " />
45+ </ form >
46+ </ div >
47+ </ div > < div class ="wy-menu wy-menu-vertical " data-spy ="affix " role ="navigation " aria-label ="Navigation menu ">
48+ < p class ="caption " role ="heading "> < span class ="caption-text "> Software</ span > </ p >
49+ < ul class ="current ">
50+ < li class ="toctree-l1 current "> < a class ="current reference internal " href ="# "> Using GACODE</ a > < ul >
51+ < li class ="toctree-l2 "> < a class ="reference internal " href ="#source-code-and-documentation "> Source code and documentation</ a > </ li >
52+ </ ul >
53+ </ li >
54+ < li class ="toctree-l1 "> < a class ="reference internal " href ="setup.html "> Prebuilt Environments</ a > </ li >
55+ < li class ="toctree-l1 "> < a class ="reference internal " href ="build.html "> Build on your laptop</ a > </ li >
56+ < li class ="toctree-l1 "> < a class ="reference internal " href ="zreferences.html "> References</ a > </ li >
57+ </ ul >
58+ < p class ="caption " role ="heading "> < span class ="caption-text "> Codes</ span > </ p >
59+ < ul >
60+ < li class ="toctree-l1 "> < a class ="reference internal " href ="neo.html "> NEO</ a > </ li >
61+ < li class ="toctree-l1 "> < a class ="reference internal " href ="tgyro.html "> TGYRO</ a > </ li >
62+ < li class ="toctree-l1 "> < a class ="reference internal " href ="cgyro.html "> CGYRO</ a > </ li >
63+ < li class ="toctree-l1 "> < a class ="reference internal " href ="gyro.html "> GYRO</ a > </ li >
64+ < li class ="toctree-l1 "> < a class ="reference internal " href ="tglf.html "> TGLF</ a > </ li >
65+ < li class ="toctree-l1 "> < a class ="reference internal " href ="prgen.html "> profiles_gen</ a > </ li >
66+ </ ul >
67+ < p class ="caption " role ="heading "> < span class ="caption-text "> Physics</ span > </ p >
68+ < ul >
69+ < li class ="toctree-l1 "> < a class ="reference internal " href ="geometry.html "> FLUX-SURFACE GEOMETRY</ a > </ li >
70+ < li class ="toctree-l1 "> < a class ="reference internal " href ="rotation.html "> PLASMA ROTATION THEORY</ a > </ li >
71+ < li class ="toctree-l1 "> < a class ="reference internal " href ="input_gacode.html "> input.gacode</ a > </ li >
72+ < li class ="toctree-l1 "> < a class ="reference internal " href ="misc.html "> Miscellaneous</ a > </ li >
73+ </ ul >
74+
75+ </ div >
76+ </ div >
77+ </ nav >
78+
79+ < section data-toggle ="wy-nav-shift " class ="wy-nav-content-wrap "> < nav class ="wy-nav-top " aria-label ="Mobile navigation menu " >
80+ < i data-toggle ="wy-nav-top " class ="fa fa-bars "> </ i >
81+ < a href ="index.html "> GACODE</ a >
82+ </ nav >
83+
84+ < div class ="wy-nav-content ">
85+ < div class ="rst-content ">
86+ < div role ="navigation " aria-label ="Page navigation ">
87+ < ul class ="wy-breadcrumbs ">
88+ < li > < a href ="index.html " class ="icon icon-home " aria-label ="Home "> </ a > </ li >
89+ < li class ="breadcrumb-item active "> Using GACODE</ li >
90+ < li class ="wy-breadcrumbs-aside ">
91+ < a href ="_sources/README.rst.txt " rel ="nofollow "> View page source</ a >
92+ </ li >
93+ </ ul >
94+ < hr />
95+ </ div >
96+ < div role ="main " class ="document " itemscope ="itemscope " itemtype ="http://schema.org/Article ">
97+ < div itemprop ="articleBody ">
98+
99+ < section id ="using-gacode ">
100+ < h1 > Using GACODE< a class ="headerlink " href ="#using-gacode " title ="Link to this heading "> </ a > </ h1 >
101+ < p > GACODE is free software released under the Apache 2.0 license. The developers of GACODE recommend the following < strong > best practices</ strong > </ p >
102+ < ol class ="arabic simple ">
103+ < li > < p > Compile/use the Software source code AS IS for publication purposes. You are welcome and encouraged to request changes through the < a class ="reference external " href ="https://github.com/gafusion/gacode/issues "> github issues system</ a > , to make code modifications for testing purposes, or to issue pull requests</ p > </ li >
104+ < li > < p > In published results or presentations, include the code name(s) and appropriate references in the table below</ p > </ li >
105+ </ ol >
106+ < table class ="docutils align-default " id ="id1 ">
107+ < caption > < span class ="caption-text "> < strong > Appropriate References</ strong > </ span > < a class ="headerlink " href ="#id1 " title ="Link to this table "> </ a > </ caption >
108+ < colgroup >
109+ < col style ="width: 27.3% " />
110+ < col style ="width: 36.4% " />
111+ < col style ="width: 36.4% " />
112+ </ colgroup >
113+ < thead >
114+ < tr class ="row-odd "> < th class ="head "> < p > Physics code</ p > </ th >
115+ < th class ="head "> < p > Topical Area</ p > </ th >
116+ < th class ="head "> < p > Suitable citation</ p > </ th >
117+ </ tr >
118+ </ thead >
119+ < tbody >
120+ < tr class ="row-even "> < td > < p > CGYRO</ p > </ td >
121+ < td > < p > gyrokinetic simulation</ p > </ td >
122+ < td > < p > < a class ="reference external " href ="https://doi.org/10.1016/j.jcp.2016.07.039 "> JCP2016</ a > </ p > </ td >
123+ </ tr >
124+ < tr class ="row-odd "> < td > < p > GYRO</ p > </ td >
125+ < td > < p > gyrokinetic simulation</ p > </ td >
126+ < td > < p > < a class ="reference external " href ="https://doi.org/10.1016/S0021-9991(03)00079-2 "> JCP2003</ a > </ p > </ td >
127+ </ tr >
128+ < tr class ="row-even "> < td > < p > NEO</ p > </ td >
129+ < td > < p > neoclassical simulation</ p > </ td >
130+ < td > < p > < a class ="reference external " href ="https://doi.org/10.1088/0741-3335/50/9/095010 "> PPCF2008</ a > | < a class ="reference external " href ="https://doi.org/10.1088/0741-3335/54/1/015015 "> PPCF2012</ a > </ p > </ td >
131+ </ tr >
132+ < tr class ="row-odd "> < td > < p > TGLF</ p > </ td >
133+ < td > < p > transport model</ p > </ td >
134+ < td > < p > < a class ="reference external " href ="https://doi.org/10.1063/1.2436852 "> POP2007</ a > | < a class ="reference external " href ="https://doi.org/10.1063/1.3505308 "> POP2010</ a > </ p > </ td >
135+ </ tr >
136+ < tr class ="row-even "> < td > < p > TGYRO</ p > </ td >
137+ < td > < p > profile evolution</ p > </ td >
138+ < td > < p > < a class ="reference external " href ="https://doi.org/10.1063/1.3167820 "> POP2009</ a > </ p > </ td >
139+ </ tr >
140+ </ tbody >
141+ </ table >
142+ < section id ="source-code-and-documentation ">
143+ < h2 > Source code and documentation< a class ="headerlink " href ="#source-code-and-documentation " title ="Link to this heading "> </ a > </ h2 >
144+ < p > Source code is found in the < a class ="reference external " href ="https://github.com/gafusion "> gacode repository</ a > .
145+ For technical documentation, please refer to the < a class ="reference external " href ="https://gacode.io "> GACODE website</ a > .</ p >
146+ </ section >
147+ </ section >
148+
149+
150+ </ div >
151+ </ div >
152+ < footer > < div class ="rst-footer-buttons " role ="navigation " aria-label ="Footer ">
153+ < a href ="index.html " class ="btn btn-neutral float-left " title ="The General Atomics GACODE Suite " accesskey ="p " rel ="prev "> < span class ="fa fa-arrow-circle-left " aria-hidden ="true "> </ span > Previous</ a >
154+ < a href ="setup.html " class ="btn btn-neutral float-right " title ="Prebuilt Environments " accesskey ="n " rel ="next "> Next < span class ="fa fa-arrow-circle-right " aria-hidden ="true "> </ span > </ a >
155+ </ div >
156+
157+ < hr />
158+
159+ < div role ="contentinfo ">
160+ < p > © Copyright 2010-2025.</ p >
161+ </ div >
162+
163+ Built with < a href ="https://www.sphinx-doc.org/ "> Sphinx</ a > using a
164+ < a href ="https://github.com/readthedocs/sphinx_rtd_theme "> theme</ a >
165+ provided by < a href ="https://readthedocs.org "> Read the Docs</ a > .
166+
167+
168+ </ footer >
169+ </ div >
170+ </ div >
171+ </ section >
172+ </ div >
173+ < script >
174+ jQuery ( function ( ) {
175+ SphinxRtdTheme . Navigation . enable ( true ) ;
176+ } ) ;
177+ </ script >
178+
179+ </ body >
180+ </ html >
0 commit comments