-
Notifications
You must be signed in to change notification settings - Fork 0
/
tutorials.html
137 lines (123 loc) · 7.34 KB
/
tutorials.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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Tutorials — BattMo documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Input Parameters" href="inputs.html" />
<link rel="prev" title="Installation instruction and requirements" href="installation.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> BattMo
<img src="_static/battmologo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#tutorial-1">Tutorial 1</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tutorial-2">Tutorial 2</a></li>
<li class="toctree-l2"><a class="reference internal" href="#more-examples">More Examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="inputs.html">BattMo Li-ion battery API</a></li>
<li class="toctree-l1"><a class="reference internal" href="geometryinput.html">Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="bibliography.html">References</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">BattMo</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li>Tutorials</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/tutorials.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="tutorials">
<h1>Tutorials<a class="headerlink" href="#tutorials" title="Permalink to this headline"></a></h1>
<p>Here, we present some tutorials and give a short description of the example scripts that are available in <code class="code docutils literal notranslate"><span class="pre">BattMo</span></code>.</p>
<div class="section" id="tutorial-1">
<h2>Tutorial 1<a class="headerlink" href="#tutorial-1" title="Permalink to this headline"></a></h2>
<p><a class="reference external" href="publishedExamples/battMoTutorial.html">A first BattMo simulation</a></p>
<blockquote>
<div><a class="reference internal image-reference" href="_images/battMoTutorial.png"><img alt="_images/battMoTutorial.png" src="_images/battMoTutorial.png" style="width: 80%;" /></a>
</div></blockquote>
</div>
<div class="section" id="tutorial-2">
<h2>Tutorial 2<a class="headerlink" href="#tutorial-2" title="Permalink to this headline"></a></h2>
<p><a class="reference external" href="publishedExamples/runJsonScript.html">A first BattMo simulation based exclusively on json input</a></p>
</div>
<div class="section" id="more-examples">
<h2>More Examples<a class="headerlink" href="#more-examples" title="Permalink to this headline"></a></h2>
<p>In the <code class="code docutils literal notranslate"><span class="pre">Examples</span></code> directory examples, the following examples can be found. They should run out of the box (write
the name of script after <a class="reference internal" href="installation.html#installation"><span class="std std-ref">installing BattMo</span></a>). If not, tell us!</p>
<ul class="simple">
<li><p><code class="code docutils literal notranslate"><span class="pre">runBattery2D</span></code> : 2D example using <a class="reference internal" href="geometryinput.html#dgeometry"><span class="std std-ref">2D model geometry</span></a></p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">runBattery3D</span></code> : 3D example using <a class="reference internal" href="geometryinput.html#id1"><span class="std std-ref">3D model geometry</span></a></p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">runChen2020</span></code> : Example using Chen data including a comparison with <a class="reference external" href="https://www.pybamm.org/">pybamm</a></p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">runCR</span></code> : Example running for a coin cell</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">runGittTest</span></code> : Example running a Gitt test</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">runJellyRoll</span></code> : Example running a <a class="reference internal" href="geometryinput.html#jellyroll"><span class="std std-ref">jelly roll geometry</span></a></p></li>
</ul>
</div>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="installation.html" class="btn btn-neutral float-left" title="Installation instruction and requirements" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="inputs.html" class="btn btn-neutral float-right" title="Input Parameters" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2021, Simon Clark.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>