Skip to content

Commit 65f01e2

Browse files
sfiligoisfiligoi
authored
Merge pull request #7 from sfiligoi/nl_single_250228
Document NL_SINGLE_FLAG and add conda build instructions
2 parents 4a5da97 + 896970e commit 65f01e2

Some content is hidden

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

52 files changed

+824
-528
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 records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 42f11e50cbc4f08b64c4600c66d325f5
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 2e9c92f25ca4f7071953c982cc4cb35f
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/README.html‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
1-
2-
31
<!DOCTYPE html>
42
<html class="writer-html5" lang="en" data-content_root="./">
53
<head>
64
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
75

86
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
97
<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" />
8+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
9+
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
1210
<link rel="stylesheet" type="text/css" href="_static/contentui.css" />
1311

1412

1513
<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>
14+
<!--[if lt IE 9]>
15+
<script src="_static/js/html5shiv.min.js"></script>
16+
<![endif]-->
17+
18+
<script src="_static/jquery.js?v=5d32c60e"></script>
19+
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20+
<script src="_static/documentation_options.js?v=5929fcd5"></script>
21+
<script src="_static/doctools.js?v=9a2dae69"></script>
22+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
23+
<script src="_static/contentui.js"></script>
2224
<script src="_static/js/theme.js"></script>
2325
<link rel="index" title="Index" href="genindex.html" />
2426
<link rel="search" title="Search" href="search.html" />

‎docs/build.html‎

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
1-
2-
31
<!DOCTYPE html>
42
<html class="writer-html5" lang="en" data-content_root="./">
53
<head>
64
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
75

86
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
97
<title>Build on your laptop &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" />
8+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
9+
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
1210
<link rel="stylesheet" type="text/css" href="_static/contentui.css" />
1311

1412

1513
<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>
14+
<!--[if lt IE 9]>
15+
<script src="_static/js/html5shiv.min.js"></script>
16+
<![endif]-->
17+
18+
<script src="_static/jquery.js?v=5d32c60e"></script>
19+
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20+
<script src="_static/documentation_options.js?v=5929fcd5"></script>
21+
<script src="_static/doctools.js?v=9a2dae69"></script>
22+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
23+
<script src="_static/contentui.js"></script>
2224
<script src="_static/js/theme.js"></script>
2325
<link rel="index" title="Index" href="genindex.html" />
2426
<link rel="search" title="Search" href="search.html" />
@@ -109,6 +111,7 @@ <h2>First step<a class="headerlink" href="#first-step" title="Link to this headi
109111
<ul class="simple">
110112
<li><p><a class="reference internal" href="build/pre_osx.html"><span class="doc">OSX users</span></a> (MAC M2)</p></li>
111113
<li><p><a class="reference internal" href="build/pre_linux.html"><span class="doc">Linux users</span></a> (MINT, UBUNTU)</p></li>
114+
<li><p><a class="reference internal" href="build/pre_conda.html"><span class="doc">Conda users, works on both OSX and Linux</span></a> (CONDA_OMPI_GNU)</p></li>
112115
</ul>
113116
<p>If you need more help, please raise an issue at <a class="reference external" href="https://github.com/gafusion/gacode/issues">https://github.com/gafusion/gacode/issues</a></p>
114117
</section>
@@ -121,11 +124,11 @@ <h2>Source code<a class="headerlink" href="#source-code" title="Link to this hea
121124
</section>
122125
<section id="concept-of-platform-files">
123126
<h2>Concept of platform files<a class="headerlink" href="#concept-of-platform-files" title="Link to this heading"></a></h2>
124-
<p>In order to compile the full GACODE package on a new machine, <strong>platform files</strong> must be created. You can use existing ones or create your own. After cloning the repository, you can query the existing platforms using:</p>
127+
<p>In order to compile the full GACODE package on a new machine, a version of the <strong>platform files</strong> must be selected. You can use existing ones or create your own. After cloning the repository, you can query the existing platforms using:</p>
125128
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./gacode/shared/bin/gacode_platforms
126129
</pre></div>
127130
</div>
128-
<p>To create new platform files (say, for a new platform MINE) then copy/edit the following files:</p>
131+
<p>If you decide to create new platform files (say, for a new platform MINE) then create the following files, starting from one of the existing ones (say, CONDA_OMPI_GNU):</p>
129132
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$GACODE_ROOT/platform/build/make.inc.MINE
130133
$GACODE_ROOT/platform/exec/exec.MINE
131134
$GACODE_ROOT/platform/env/env.MINE (if needed)
@@ -145,7 +148,7 @@ <h2>Environment variables<a class="headerlink" href="#environment-variables" tit
145148
</section>
146149
<section id="openblas">
147150
<h2>OpenBLAS<a class="headerlink" href="#openblas" title="Link to this heading"></a></h2>
148-
<p>When building with gfortran, we recommend using <a class="reference external" href="https://github.com/xianyi/OpenBLAS.git">OpenBLAS</a>. It is important to build with <strong>single-threaded</strong> settings. In the Makefile.rule file in the top-level OpenBLAS directory, set:</p>
151+
<p>Using system provided builds is better, but when building from scrath with gfortran, we recommend using <a class="reference external" href="https://github.com/xianyi/OpenBLAS.git">OpenBLAS</a>. It is important to build with <strong>single-threaded</strong> settings. In the Makefile.rule file in the top-level OpenBLAS directory, set:</p>
149152
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">BINARY</span><span class="o">=</span><span class="mi">64</span>
150153
<span class="n">USE_THREAD</span><span class="o">=</span><span class="mi">0</span>
151154
<span class="n">USE_LOCKING</span><span class="o">=</span><span class="mi">1</span>
@@ -167,6 +170,10 @@ <h2>Building<a class="headerlink" href="#building" title="Link to this heading">
167170
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cd $GACODE_ROOT ; make
168171
</pre></div>
169172
</div>
173+
<p>To build just one of the tools, go into the specific subdirectory:</p>
174+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cd $GACODE_ROOT/cgyro ; make
175+
</pre></div>
176+
</div>
170177
<p>To test that the build is successful, you can run regression tests:</p>
171178
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ neo -r
172179
$ tglf -r

‎docs/build/pre_conda.html‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="en" data-content_root="../">
3+
<head>
4+
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
5+
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>Conda setup &mdash; GACODE</title>
8+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
9+
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
10+
<link rel="stylesheet" type="text/css" href="../_static/contentui.css" />
11+
12+
13+
<link rel="shortcut icon" href="../_static/favicon.ico"/>
14+
<!--[if lt IE 9]>
15+
<script src="../_static/js/html5shiv.min.js"></script>
16+
<![endif]-->
17+
18+
<script src="../_static/jquery.js?v=5d32c60e"></script>
19+
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20+
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
21+
<script src="../_static/doctools.js?v=9a2dae69"></script>
22+
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
23+
<script src="../_static/contentui.js"></script>
24+
<script src="../_static/js/theme.js"></script>
25+
<link rel="index" title="Index" href="../genindex.html" />
26+
<link rel="search" title="Search" href="../search.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>
50+
<li class="toctree-l1"><a class="reference internal" href="../README.html">Using GACODE</a></li>
51+
<li class="toctree-l1"><a class="reference internal" href="../setup.html">Prebuilt Environments</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="../build.html">Build on your laptop</a></li>
53+
<li class="toctree-l1"><a class="reference internal" href="../zreferences.html">References</a></li>
54+
</ul>
55+
<p class="caption" role="heading"><span class="caption-text">Codes</span></p>
56+
<ul>
57+
<li class="toctree-l1"><a class="reference internal" href="../neo.html">NEO</a></li>
58+
<li class="toctree-l1"><a class="reference internal" href="../tgyro.html">TGYRO</a></li>
59+
<li class="toctree-l1"><a class="reference internal" href="../cgyro.html">CGYRO</a></li>
60+
<li class="toctree-l1"><a class="reference internal" href="../gyro.html">GYRO</a></li>
61+
<li class="toctree-l1"><a class="reference internal" href="../tglf.html">TGLF</a></li>
62+
<li class="toctree-l1"><a class="reference internal" href="../prgen.html">profiles_gen</a></li>
63+
</ul>
64+
<p class="caption" role="heading"><span class="caption-text">Physics</span></p>
65+
<ul>
66+
<li class="toctree-l1"><a class="reference internal" href="../geometry.html">FLUX-SURFACE GEOMETRY</a></li>
67+
<li class="toctree-l1"><a class="reference internal" href="../rotation.html">PLASMA ROTATION THEORY</a></li>
68+
<li class="toctree-l1"><a class="reference internal" href="../input_gacode.html">input.gacode</a></li>
69+
<li class="toctree-l1"><a class="reference internal" href="../misc.html">Miscellaneous</a></li>
70+
</ul>
71+
72+
</div>
73+
</div>
74+
</nav>
75+
76+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
77+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
78+
<a href="../index.html">GACODE</a>
79+
</nav>
80+
81+
<div class="wy-nav-content">
82+
<div class="rst-content">
83+
<div role="navigation" aria-label="Page navigation">
84+
<ul class="wy-breadcrumbs">
85+
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
86+
<li class="breadcrumb-item active">Conda setup</li>
87+
<li class="wy-breadcrumbs-aside">
88+
<a href="../_sources/build/pre_conda.rst.txt" rel="nofollow"> View page source</a>
89+
</li>
90+
</ul>
91+
<hr/>
92+
</div>
93+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
94+
<div itemprop="articleBody">
95+
96+
<section id="conda-setup">
97+
<h1>Conda setup<a class="headerlink" href="#conda-setup" title="Link to this heading"></a></h1>
98+
<p>The conda setup can be used as a regular user (no sudo privileges needed), and works on both OSX and Linux.</p>
99+
<p>If you do not have an existing conda setup yet, download and install Miniconda from <a class="reference external" href="https://www.anaconda.com/download/">https://www.anaconda.com/download/</a></p>
100+
<p>Once inside the conda setup, create the conda gacode environment.</p>
101+
<p>On Linux:</p>
102+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ conda create -n gacode -c conda-forge gfortran binutils make python fftw openmpi netcdf4 libopenblas=*=*openmp*
103+
</pre></div>
104+
</div>
105+
<p>On OSX:</p>
106+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ conda create -n gacode -c conda-forge gfortran make python fftw openmpi netcdf4
107+
</pre></div>
108+
</div>
109+
<p>Since many conda environment can co-exist on a single machine, activate the gacode one when using the GACODE tools:</p>
110+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ conda activate gacode
111+
</pre></div>
112+
</div>
113+
</section>
114+
115+
116+
</div>
117+
</div>
118+
<footer>
119+
120+
<hr/>
121+
122+
<div role="contentinfo">
123+
<p>&#169; Copyright 2010-2025.</p>
124+
</div>
125+
126+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
127+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
128+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
129+
130+
131+
</footer>
132+
</div>
133+
</div>
134+
</section>
135+
</div>
136+
<script>
137+
jQuery(function () {
138+
SphinxRtdTheme.Navigation.enable(true);
139+
});
140+
</script>
141+
142+
</body>
143+
</html>

‎docs/build/pre_linux.html‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
1-
2-
31
<!DOCTYPE html>
42
<html class="writer-html5" lang="en" data-content_root="../">
53
<head>
64
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
75

86
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
97
<title>Ubuntu/Mint &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" />
8+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
9+
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
1210
<link rel="stylesheet" type="text/css" href="../_static/contentui.css" />
1311

1412

1513
<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>
14+
<!--[if lt IE 9]>
15+
<script src="../_static/js/html5shiv.min.js"></script>
16+
<![endif]-->
17+
18+
<script src="../_static/jquery.js?v=5d32c60e"></script>
19+
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20+
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
21+
<script src="../_static/doctools.js?v=9a2dae69"></script>
22+
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
23+
<script src="../_static/contentui.js"></script>
2224
<script src="../_static/js/theme.js"></script>
2325
<link rel="index" title="Index" href="../genindex.html" />
2426
<link rel="search" title="Search" href="../search.html" />

‎docs/build/pre_osx.html‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
1-
2-
31
<!DOCTYPE html>
42
<html class="writer-html5" lang="en" data-content_root="../">
53
<head>
64
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
75

86
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
97
<title>OSX Sonoma &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" />
8+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
9+
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
1210
<link rel="stylesheet" type="text/css" href="../_static/contentui.css" />
1311

1412

1513
<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>
14+
<!--[if lt IE 9]>
15+
<script src="../_static/js/html5shiv.min.js"></script>
16+
<![endif]-->
17+
18+
<script src="../_static/jquery.js?v=5d32c60e"></script>
19+
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20+
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
21+
<script src="../_static/doctools.js?v=9a2dae69"></script>
22+
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
23+
<script src="../_static/contentui.js"></script>
2224
<script src="../_static/js/theme.js"></script>
2325
<link rel="index" title="Index" href="../genindex.html" />
2426
<link rel="search" title="Search" href="../search.html" />

0 commit comments

Comments
 (0)