Skip to content

Commit 4a5da97

Browse files
committed
Deploy to web
1 parent 49d7b30 commit 4a5da97

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+1166
-658
lines changed

docs/.buildinfo

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
2-
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: ffa9270b90cdd9fb560826aca3bd95a4
2+
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 42f11e50cbc4f08b64c4600c66d325f5
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/README.html

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
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 &mdash; 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>&#169; 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>

docs/build.html

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
1+
2+
13
<!DOCTYPE html>
2-
<html class="writer-html5" lang="en" >
4+
<html class="writer-html5" lang="en" data-content_root="./">
35
<head>
46
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
57

68
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
79
<title>Build on your laptop &mdash; GACODE</title>
8-
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
9-
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
10-
<link rel="stylesheet" href="_static/contentui.css" type="text/css" />
11-
<!--[if lt IE 9]>
12-
<script src="_static/js/html5shiv.min.js"></script>
13-
<![endif]-->
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+
1414

15-
<script src="_static/documentation_options.js?v=5929fcd5"></script>
16-
<script src="_static/doctools.js?v=888ff710"></script>
17-
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
18-
<script src="_static/contentui.js"></script>
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>
1922
<script src="_static/js/theme.js"></script>
2023
<link rel="index" title="Index" href="genindex.html" />
2124
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +31,15 @@
2831
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
2932
<div class="wy-side-scroll">
3033
<div class="wy-side-nav-search" >
31-
<a href="index.html" class="icon icon-home"> GACODE
34+
35+
36+
37+
<a href="index.html" class="icon icon-home">
38+
GACODE
3239
</a>
3340
<div role="search">
3441
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
35-
<input type="text" name="q" placeholder="Search docs" />
42+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
3643
<input type="hidden" name="check_keywords" value="yes" />
3744
<input type="hidden" name="area" value="default" />
3845
</form>
@@ -83,7 +90,7 @@
8390
<div class="rst-content">
8491
<div role="navigation" aria-label="Page navigation">
8592
<ul class="wy-breadcrumbs">
86-
<li><a href="index.html" class="icon icon-home"></a></li>
93+
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
8794
<li class="breadcrumb-item active">Build on your laptop</li>
8895
<li class="wy-breadcrumbs-aside">
8996
<a href="_sources/build.rst.txt" rel="nofollow"> View page source</a>

docs/build/pre_linux.html

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
1+
2+
13
<!DOCTYPE html>
2-
<html class="writer-html5" lang="en" >
4+
<html class="writer-html5" lang="en" data-content_root="../">
35
<head>
46
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
57

68
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
79
<title>Ubuntu/Mint &mdash; GACODE</title>
8-
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
9-
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
10-
<link rel="stylesheet" href="../_static/contentui.css" type="text/css" />
11-
<!--[if lt IE 9]>
12-
<script src="../_static/js/html5shiv.min.js"></script>
13-
<![endif]-->
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+
1414

15-
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
16-
<script src="../_static/doctools.js?v=888ff710"></script>
17-
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
18-
<script src="../_static/contentui.js"></script>
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>
1922
<script src="../_static/js/theme.js"></script>
2023
<link rel="index" title="Index" href="../genindex.html" />
2124
<link rel="search" title="Search" href="../search.html" />
@@ -26,11 +29,15 @@
2629
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
2730
<div class="wy-side-scroll">
2831
<div class="wy-side-nav-search" >
29-
<a href="../index.html" class="icon icon-home"> GACODE
32+
33+
34+
35+
<a href="../index.html" class="icon icon-home">
36+
GACODE
3037
</a>
3138
<div role="search">
3239
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
33-
<input type="text" name="q" placeholder="Search docs" />
40+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
3441
<input type="hidden" name="check_keywords" value="yes" />
3542
<input type="hidden" name="area" value="default" />
3643
</form>
@@ -73,7 +80,7 @@
7380
<div class="rst-content">
7481
<div role="navigation" aria-label="Page navigation">
7582
<ul class="wy-breadcrumbs">
76-
<li><a href="../index.html" class="icon icon-home"></a></li>
83+
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
7784
<li class="breadcrumb-item active">Ubuntu/Mint</li>
7885
<li class="wy-breadcrumbs-aside">
7986
<a href="../_sources/build/pre_linux.rst.txt" rel="nofollow"> View page source</a>

docs/build/pre_osx.html

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
1+
2+
13
<!DOCTYPE html>
2-
<html class="writer-html5" lang="en" >
4+
<html class="writer-html5" lang="en" data-content_root="../">
35
<head>
46
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
57

68
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
79
<title>OSX Sonoma &mdash; GACODE</title>
8-
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
9-
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
10-
<link rel="stylesheet" href="../_static/contentui.css" type="text/css" />
11-
<!--[if lt IE 9]>
12-
<script src="../_static/js/html5shiv.min.js"></script>
13-
<![endif]-->
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+
1414

15-
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
16-
<script src="../_static/doctools.js?v=888ff710"></script>
17-
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
18-
<script src="../_static/contentui.js"></script>
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>
1922
<script src="../_static/js/theme.js"></script>
2023
<link rel="index" title="Index" href="../genindex.html" />
2124
<link rel="search" title="Search" href="../search.html" />
@@ -26,11 +29,15 @@
2629
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
2730
<div class="wy-side-scroll">
2831
<div class="wy-side-nav-search" >
29-
<a href="../index.html" class="icon icon-home"> GACODE
32+
33+
34+
35+
<a href="../index.html" class="icon icon-home">
36+
GACODE
3037
</a>
3138
<div role="search">
3239
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
33-
<input type="text" name="q" placeholder="Search docs" />
40+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
3441
<input type="hidden" name="check_keywords" value="yes" />
3542
<input type="hidden" name="area" value="default" />
3643
</form>
@@ -73,7 +80,7 @@
7380
<div class="rst-content">
7481
<div role="navigation" aria-label="Page navigation">
7582
<ul class="wy-breadcrumbs">
76-
<li><a href="../index.html" class="icon icon-home"></a></li>
83+
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
7784
<li class="breadcrumb-item active">OSX Sonoma</li>
7885
<li class="wy-breadcrumbs-aside">
7986
<a href="../_sources/build/pre_osx.rst.txt" rel="nofollow"> View page source</a>

0 commit comments

Comments
 (0)