-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
283 lines (268 loc) · 17.9 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="utf-8" />
<title>Welcome — Magic 6.3 documentation</title>
<link rel="stylesheet" href="_static/magic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Magic 6.3 documentation"
href="_static/opensearch.xml"/>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link href='http://fonts.googleapis.com/css?family=Open+Sans:300,400,700'
rel='stylesheet' type='text/css' />
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1/jquery.js"></script>
<script src="galleria/galleria-1.4.2.min.js"></script>
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
.related { display: none; }
</style>
<script type="text/javascript">
// intelligent scrolling of the sidebar content
$(window).scroll(function() {
var sb = $('.sphinxsidebarwrapper');
var win = $(window);
var sbh = sb.height();
var offset = $('.sphinxsidebar').position()['top'];
var wintop = win.scrollTop();
var winbot = wintop + win.innerHeight();
var curtop = sb.position()['top'];
var curbot = curtop + sbh;
// does sidebar fit in window?
if (sbh < win.innerHeight()) {
// yes: easy case -- always keep at the top
sb.css('top', $u.min([$u.max([0, wintop - offset - 10]),
$(document).height() - sbh - 200]));
} else {
// no: only scroll if top/bottom edge of sidebar is at
// top/bottom edge of window
if (curtop > wintop && curbot > winbot) {
sb.css('top', $u.max([wintop - offset - 10, 0]));
} else if (curtop < wintop && curbot < winbot) {
sb.css('top', $u.min([winbot - sbh - offset - 20,
$(document).height() - sbh - 200]));
}
}
});
</script>
</head><body>
<div class="pageheader">
<ul>
<li><a href="#">Home</a></li>
<li><a href="install.html">Get it/Run it</a></li>
<li><a href="contribute.html">Contribute!</a></li>
<li><a href="numerics.html">Numerical methods</a></li>
<li><a href="contents.html">Contents</a></li>
</ul>
<div>
<a href="#">
<img src="_static/logo.png" alt="magic" height="120px" width="192px"/>
</a>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="f-modindex.html" title="Fortran Module Index"
>fortran modules</a> |</li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="contents.html">Magic 6.3 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="welcome">
<h1>Welcome<a class="headerlink" href="#welcome" title="Permalink to this headline">¶</a></h1>
<div class="mybox docutils container">
<blockquote>
<div><div class="galleria">
<img src=_images/benchmark.png data-title="Dynamo benchmark" data-description="<a href='http://dx.doi.org/10.1016/S0031-9201(01)00275-8'>Christensen et al., PEPI, 2001</a>" >
<img src=_images/3DBr.png data-title="A numerical model of the Jovian dynamo" data-description="<a href='http://dx.doi.org/10.1002/2014GL060814'>Gastine, T. et al., GRL, 2014</a>">
<img src=_images/VsNS_E-4oIC-20000.jpg data-title="Inertial mode in a spherical Couette flow" data-description="<a href='http://dx.doi.org/10.1017/jfm.2013.545'>Wicht, J., JFM, 2014</a>">
<img src=_images/Conv.png data-title="Rayleigh-Bénard convection in non-rotating spherical shell" data-description="<a href='http://dx.doi.org/10.1017/jfm.2015.401'>Gastine, T. et al., JFM, 2015</a>">
<img src=_images/wielandMars.png data-title="A hemispherical dynamo model to explain the Martian crustal magnetization" data-description="<a href='http://dx.doi.org/10.1016/j.pepi.2013.01.001'>Dietrich, W. et al., PEPI, 2013</a>">
<img src=_images/MRI_sphere.png data-title="Magneto-rotational instability in spherical shell" data-description="<a href='http://dx.doi.org/10.1051/0004-6361/201425240'>Jouve, L. et al., A&A, 2015</a>">
<img src=_images/kristaEuropa.jpg data-title="Ocean-driven heating of Europa's icy shell at low latitudes" data-description="<a href='http://dx.doi.org/10.1038/ngeo2021'>Soderlund, K. et al., Nature Geoscience, 2014</a>">
<img src=_images/AubertNature.png data-title="Numerical model of the geodynamo" data-description="<a href='http://dx.doi.org/10.1038/nature07109'>Aubert, J. et al., Nature, 2008</a>">
<img src=_images/caoIcarus.png data-title="Spherical Couette dynamo to explain the Saturnian magnetic field" data-description="<a href='http://dx.doi.org/10.1016/j.icarus.2012.08.007'>Cao, H. et al., Icarus, 2012</a>">
<img src=_images/yadav2015.png data-title="Formation of polar spots in a fully-convective star model" data-description="<a href='http://dx.doi.org/10.1051/0004-6361/201424589'>Yadav, R. et al., A&A, 2015</a>">
<img src=_images/heimpel05.png data-title="Numerical model of the Jovian zonal jets" data-description="<a href='http://dx.doi.org/10.1038/nature04208'>Heimpel, M. et al., Nature, 2005</a>">
</div>
<script>
Galleria.loadTheme('galleria/themes/classic/galleria.classic.min.js');
Galleria.run('.galleria', {responsive:true, height:0.4, autoplay: 3000, transition:'fadeslide', pauseOnInteraction: false});
</script></div></blockquote>
<p><strong>MagIC</strong> is a numerical code that can simulate fluid dynamics in a spherical
shell. MagIC solves for the Navier-Stokes equation including Coriolis force,
optionally coupled with an induction equation for Magneto-Hydro Dynamics (MHD),
a temperature (or entropy) equation and an equation for chemical composition
under both the anelastic and the Boussinesq approximations.</p>
<p><strong>MagIC</strong> uses Chebyshev polynomials or finite difference in the radial
direction and spherical harmonic decomposition in the azimuthal and latitudinal
directions. MagIC supports several Implicit-Explicit time schemes where the
nonlinear terms and the Coriolis force are treated explicitly, while the
remaining linear terms are treated implicitly.</p>
<p><strong>MagIC</strong> is written in Fortran and designed to be used on supercomputing
clusters. It thus relies on a hybrid parallelisation scheme using both <a class="reference external" href="http://openmp.org/wp/">OpenMP</a> and <a class="reference external" href="http://www.open-mpi.org/">MPI</a>. Postprocessing
functions written in python (requiring <a class="reference external" href="http://matplotlib.org/">matplotlib</a>
and <a class="reference external" href="http://www.scipy.org/">scipy</a>) are also provided to allow a useful data
analysis.</p>
<div class="figure align-center" id="id1">
<a class="reference internal image-reference" href="_images/magic_occigen.png"><img alt="caption" src="_images/magic_occigen.png" style="width: 450px;" /></a>
<p class="caption"><span class="caption-text">Walltime of MagIC on <a class="reference external" href="https://www.cines.fr/en/supercomputing-2/hardwares/the-supercomputer-occigen/">Occigen</a> versus number of cores
for a Boussinesq dynamo model computed at three different numerical resolutions
<span class="math notranslate nohighlight">\((N_r,\ell_{\text{max}})\)</span>.</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
</div>
<p><strong>MagIC</strong> is a free software. It can be used, modified and redistributed under the
terms of the <a class="reference external" href="http://www.gnu.org/licenses/gpl-3.0.en.html">GNU GPL v3 licence</a>.</p>
</div>
<div class="section" id="quickly-starting-using-magic">
<h2>Quickly starting using MagIC<a class="headerlink" href="#quickly-starting-using-magic" title="Permalink to this headline">¶</a></h2>
<div class="mybox docutils container">
<ul class="simple">
<li><p>The <a class="reference internal" href="install.html#secquickstart"><span class="std std-ref">quick-starting guide</span></a> will help you to download,
set up and run your first numerical simulations using <strong>MagIC</strong>.</p></li>
<li><p>The <a class="reference internal" href="inputNamelists/namelists.html#secnamelists"><span class="std std-ref">description of the input namelists</span></a> will then help
you to define the exact physical setup you may want to simulate.</p></li>
<li><p>The <a class="reference internal" href="outputFiles/outFiles.html#secoutputfiles"><span class="std std-ref">description of the output files</span></a> will help you to
understand what are the diagnostic quantities computed by <strong>MagIC</strong>.</p></li>
<li><p>Finally, the <a class="reference internal" href="postProc.html#secpythonpostproc"><span class="std std-ref">python functions and classes</span></a> will
allow you to do some advanced post-processing analyses on the outputs of <strong>MagIC</strong>.</p></li>
</ul>
</div>
</div>
<div class="section" id="documentation">
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
<div class="mybox docutils container">
<ul class="simple">
<li><p>The <a class="reference internal" href="contents.html#contents"><span class="std std-ref">table of contents</span></a> gives an overview of the complete documentation.</p></li>
<li><p>The <a class="reference internal" href="equations.html#secequations"><span class="std std-ref">formulation of the (M)HD problem</span></a> contains an exhaustive
description of the equations solved by the MagIC code.</p></li>
<li><p>The <a class="reference internal" href="numerics.html#secnumerics"><span class="std std-ref">numerical methods section</span></a> contains the description of the
numerical technique.</p></li>
<li><p>The <a class="reference internal" href="search.html"><span class="std std-ref">search page</span></a> allows to search the documentation.</p></li>
<li><p>The <a class="reference internal" href="api.html#secfortranapi"><span class="std std-ref">fortran API</span></a> contains a generic description of all
Fortran variables, subroutines and modules used in <strong>MagIC</strong>.</p></li>
</ul>
<p>You can also download a <a class="reference download internal" download="" href="_downloads/b36f2820048a180af081e627f6701ed8/magic_manual.pdf"><code class="xref download docutils literal notranslate"><span class="pre">PDF</span> <span class="pre">version</span></code></a> of this
documentation generated from LaTeX Sphinx.</p>
</div>
</div>
<div class="section" id="contributing-to-the-code">
<h2>Contributing to the code<a class="headerlink" href="#contributing-to-the-code" title="Permalink to this headline">¶</a></h2>
<div class="mybox docutils container">
<p>If you want to contribute to <strong>MagIC</strong>, <a class="reference internal" href="contribute.html#seccontribute"><span class="std std-ref">the contributor
guide</span></a> might be helpful for you.</p>
</div>
</div>
<div class="section" id="giving-credit">
<h2>Giving credit<a class="headerlink" href="#giving-credit" title="Permalink to this headline">¶</a></h2>
<div class="mybox docutils container">
<p>In case you intend to publish scientific results obtained with <strong>MagIC</strong>
or present them in a conference, we (the developers of MagIC) kindly
ask to be acknowledged with a reference to the website
<a class="reference external" href="https://magic-sph.github.io/">https://magic-sph.github.io/</a> or <a class="reference external" href="https://github.com/magic-sph/magic">https://github.com/magic-sph/magic</a>.</p>
<p>We also suggest to give appropriate reference to one or several of the following
papers:</p>
<ul class="simple">
<li><p>Boussinesq equations: <a class="reference external" href="http://dx.doi.org/10.1016/S0031-9201(02)00078-X">Wicht (2002, PEPI, 132, 281-302)</a></p></li>
<li><p>Anelastic equations: <a class="reference external" href="http://dx.doi.org/10.1016/j.icarus.2012.03.018">Gastine & Wicht (2012, Icarus, 219, 28-442)</a></p></li>
<li><p>Boussinesq benchmark: <a class="reference external" href="http://dx.doi.org/10.1016/S0031-9201(01)00275-8">Christensen et al. (2001, PEPI, 128, 25-34)</a></p></li>
<li><p>Benchmark for double diffusive convection: <a class="reference external" href="http://dx.doi.org/11.1111/j.1365-246X.2010.04722.x">Breuer et al. (2010, GJI, 183, 150-162)</a></p></li>
<li><p>Anelastic benchmark: <a class="reference external" href="http://dx.doi.org/10.1016/j.icarus.2011.08.014">Jones et al. (2011, Icarus, 216, 120-135)</a></p></li>
<li><p>In case you use the <a class="reference external" href="https://bitbucket.org/bputigny/shtns-magic">SHTns</a> library for the spherical harmonics transforms (MagIC 5.3 or later), please also cite: <a class="reference external" href="http://dx.doi.org/10.1002/ggge.20071">Schaeffer (2013, GGG, 14, 751-758)</a></p></li>
</ul>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p>A (tentative) comprehensive list of the publications that have
been produced to date (May 2024) using <strong>MagIC</strong>
is accessible <a class="reference external" href="https://ui.adsabs.harvard.edu/public-libraries/LVt1vdaKQsC5P09In2iloA">here</a>.
To date, more than <strong>150 publications</strong> have been-accepted in
more than 20 different peer-reviewed journals: <a class="reference external" href="http://www.journals.elsevier.com/physics-of-the-earth-and-planetary-interiors/">PEPI</a>
(25), <a class="reference external" href="http://www.journals.elsevier.com/icarus/">Icarus</a> (15), <a class="reference external" href="www.journals.elsevier.com/earth-and-planetary-science-letters/">E&PSL</a> (7), <a class="reference external" href="http://gji.oxfordjournals.org/">GJI</a> (17), <a class="reference external" href="http://www.aanda.org/">A&A</a> (16),
<a class="reference external" href="http://agupubs.onlinelibrary.wiley.com/agu/journal/10.1002/(ISSN)1944-8007/">GRL</a> (7),
<a class="reference external" href="http://journals.cambridge.org/action/displayJournal?jid=FLM">JFM</a> (7),
<a class="reference external" href="http://www.tandfonline.com/toc/ggaf20/current">GAFD</a> (3),
<a class="reference external" href="http://www.nature.com/nature">Nature</a> (2), etc.</p>
</div>
<div class="figure align-center" id="id2">
<a class="reference internal image-reference" href="_images/magic_pubs.png"><img alt="caption" src="_images/magic_pubs.png" style="width: 600px;" /></a>
<p class="caption"><span class="caption-text">Number of peer-reviewed publications produced using <strong>MagIC</strong></span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome</a><ul>
<li><a class="reference internal" href="#quickly-starting-using-magic">Quickly starting using MagIC</a></li>
<li><a class="reference internal" href="#documentation">Documentation</a></li>
<li><a class="reference internal" href="#contributing-to-the-code">Contributing to the code</a></li>
<li><a class="reference internal" href="#giving-credit">Giving credit</a></li>
</ul>
</li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="f-modindex.html" title="Fortran Module Index"
>fortran modules</a> |</li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="contents.html">Magic 6.3 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2023, Thomas Gastine, Johannes Wicht, Ankit Barik, Lùcia Duarte.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.3.1.
</div>
</body>
</html>