-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathdocumentation.html
More file actions
159 lines (146 loc) · 9.47 KB
/
documentation.html
File metadata and controls
159 lines (146 loc) · 9.47 KB
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
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Thetis documentation — Thetis 2025.10.1+1.gf513865b documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/thetis.css?v=0f3339d6" />
<script src="_static/documentation_options.js?v=b0987aea"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<!--[if lte IE 6]>
<link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
<![endif]-->
<!-- <link rel="stylesheet" href="_static/featured.css"> -->
<link rel="shortcut icon" href="_static/icon_thetis.ico" />
</head><body>
<div class="wrapper">
<a href="index.html"><img src="_static/banner.jpg" height="180px" alt="Thetis Project Banner" /></a>
<div id="access">
<div class="menu">
<ul>
<li class="page_item"><a href="#" title="Thetis documentation">Documentation</a></li>
<li class="page_item"><a href="download.html" title="Install Thetis">Download</a></li>
<li class="page_item"><a href="team.html" title="Development team">Team</a></li>
<li class="page_item"><a href="publications.html" title="Publications">Publications</a></li>
<li class="page_item"><a href="funding.html" title="Our financial supporters">Funding</a></li>
<li class="page_item"><a href="contact.html" title="Getting in touch">Contact</a></li>
<li class="page_item"><a href="https://github.com/thetisproject/thetis" title="Thetis source on GitHub">GitHub</a></li>
</ul>
</div><!-- .menu -->
</div><!-- #access -->
</div><!-- #wrapper -->
<div class="document">
<div class="documentation">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="thetis-documentation">
<h1>Thetis documentation<a class="headerlink" href="#thetis-documentation" title="Link to this heading">¶</a></h1>
<section id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h2>
<p>See <a class="reference internal" href="download.html"><span class="doc">obtaining Thetis</span></a> for installation instructions.</p>
</section>
<section id="tutorials">
<h2>Tutorials<a class="headerlink" href="#tutorials" title="Link to this heading">¶</a></h2>
<p>Once Thetis is successfully installed, you can start running example
simulations that demonstrate basic functionality.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Setting up Thetis simulations makes use of Firedrake objects,
such as meshes, functions, and expression.
In order to be able to follow these demo simulations,
it is essential to have a basic understanding of these objects.
Please refer to the
<a class="reference external" href="http://firedrakeproject.org/documentation.html">Firedrake manual</a>
for more information.
<a class="reference external" href="http://firedrakeproject.org/variational-problems.html">Defining variational problems</a>
page is a good primer for understanding the Firedrake concepts.</p>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="demos/demo_2d_channel.py.html">2D channel with closed boundaries</a></li>
<li class="toctree-l1"><a class="reference internal" href="demos/demo_2d_channel_bnd.py.html">2D channel with boundary conditions</a></li>
<li class="toctree-l1"><a class="reference internal" href="demos/demo_3d_channel.py.html">3D channel with boundary conditions</a></li>
<li class="toctree-l1"><a class="reference internal" href="demos/demo_2d_tracer.py.html">2D tracer advection in a rotational velocity field</a></li>
<li class="toctree-l1"><a class="reference internal" href="demos/demo_2d_multiple_tracers.py.html">2D tracer advection with multiple tracers</a></li>
<li class="toctree-l1"><a class="reference internal" href="demos/demo_2d_north_sea.py.html">2D North Sea tidal model</a></li>
</ul>
</div>
</section>
<section id="jupyter-notebooks">
<h2>Jupyter Notebooks<a class="headerlink" href="#jupyter-notebooks" title="Link to this heading">¶</a></h2>
<p>Thetis provides a few example Jupyter notebooks that demonstrate how to run typical simulations
in an interactive, editable format. These are designed to help you get familiar with setting up and
running Thetis models, and to experiment with different scenarios.</p>
<section id="running-the-notebooks-locally">
<h3>Running the notebooks locally<a class="headerlink" href="#running-the-notebooks-locally" title="Link to this heading">¶</a></h3>
<p>To run the notebooks on your own machine, you will first need to install
<a class="reference external" href="https://jupyter.org/install.html">Jupyter</a> in the same Python environment where you installed Firedrake and Thetis:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">source</span><span class="w"> </span>~/venv-firedrake/bin/activate
pip<span class="w"> </span>install<span class="w"> </span>jupyterlab<span class="w"> </span>notebook
</pre></div>
</div>
<p>The notebooks are available in your Thetis source directory under <code class="docutils literal notranslate"><span class="pre">demos/</span></code>.</p>
</section>
<section id="running-the-notebooks-on-google-colab">
<h3>Running the notebooks on Google Colab<a class="headerlink" href="#running-the-notebooks-on-google-colab" title="Link to this heading">¶</a></h3>
<p>Thanks to <a class="reference external" href="https://fem-on-colab.github.io/index.html">FEM on Colab</a> by <a class="reference external" href="https://www.francescoballarin.it">Francesco
Ballarin</a>, you can also run these notebooks
directly in your web browser without installing anything locally.</p>
<p>You can launch the notebooks using the Colab badge below each notebook link.</p>
</section>
<section id="available-notebooks">
<h3>Available notebooks:<a class="headerlink" href="#available-notebooks" title="Link to this heading">¶</a></h3>
<ul>
<li><p><a class="reference external" href="https://github.com/thetisproject/thetis/blob/main/demos/01-2d-channel.ipynb">01-2d-channel.ipynb</a></p>
<a class="reference external image-reference" href="https://colab.research.google.com/github/thetisproject/thetis/blob/main/demos/01-2d-channel.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" />
</a>
</li>
<li><p><a class="reference external" href="https://github.com/thetisproject/thetis/blob/main/demos/02-2d-tsunami.ipynb">02-2d-tsunami.ipynb</a></p>
<a class="reference external image-reference" href="https://colab.research.google.com/github/thetisproject/thetis/blob/main/demos/02-2d-tsunami.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" />
</a>
</li>
</ul>
</section>
</section>
<section id="manual">
<h2>Manual<a class="headerlink" href="#manual" title="Link to this heading">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="model_formulation_2d.html">2D hydrodynamics model formulation</a></li>
<li class="toctree-l1"><a class="reference internal" href="tracer_formulation_2d.html">2D tracer model formulation</a></li>
<li class="toctree-l1"><a class="reference internal" href="sediment_formulation_2d.html">2D sediment model formulation</a></li>
<li class="toctree-l1"><a class="reference internal" href="model_formulation_3d.html">3D model formulation</a></li>
<li class="toctree-l1"><a class="reference internal" href="outputs_and_visu.html">Model outputs and visualization</a></li>
<li class="toctree-l1"><a class="reference internal" href="model_options_2d.html">List of 2D model options</a></li>
<li class="toctree-l1"><a class="reference internal" href="model_options_3d.html">List of 3D model options</a></li>
<li class="toctree-l1"><a class="reference internal" href="sediment_model_options.html">List of 2D sediment model options</a></li>
<li class="toctree-l1"><a class="reference internal" href="field_documentation.html">List of physical fields</a></li>
</ul>
</div>
</section>
<section id="api-documentation">
<h2>API documentation<a class="headerlink" href="#api-documentation" title="Link to this heading">¶</a></h2>
<p>The complete list of all the classes and methods is
available at the <a class="reference internal" href="thetis.html"><span class="doc">thetis package</span></a> page. The same information is <a class="reference internal" href="genindex.html"><span class="std std-ref">indexed</span></a> in alphabetical order. Another very effective mechanism is
the site <a class="reference internal" href="search.html"><span class="std std-ref">search engine</span></a>.</p>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
© Copyright 2016-2025, Tuomas Kärnä et al..
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
</div>
</body>
</html>