-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
446 lines (410 loc) · 15.8 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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-05-20 Thu 13:19 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Calculate electrical response induced by drifting charge</title>
<meta name="generator" content="Org mode" />
<meta name="author" content="Brett Viren" />
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #ccc;
box-shadow: 3px 3px 3px #eee;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: auto;
padding-top: 1.2em;
}
pre.src:before {
display: none;
position: absolute;
background-color: white;
top: -10px;
right: 10px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline; margin-top: 14px;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-hledger:before { content: 'hledger'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.equation-container {
display: table;
text-align: center;
width: 100%;
}
.equation {
vertical-align: middle;
}
.equation-label {
display: table-cell;
text-align: right;
vertical-align: middle;
}
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { width: 90%; }
/*]]>*/-->
</style>
<link rel="stylesheet" type="text/css" href="https://brettviren.github.io/moo/other/readtheorg/css/htmlize.css"/>
<link rel="stylesheet" type="text/css" href="https://brettviren.github.io/moo/other/readtheorg/css/readtheorg.css"/>
<script type="text/javascript" src="https://brettviren.github.io/moo/other/lib/js/jquery.min.js"></script>
<script type="text/javascript" src="https://brettviren.github.io/moo/other/lib/js/bootstrap.min.js"></script>
<script type="text/javascript" src="https://brettviren.github.io/moo/other/lib/js/jquery.stickytableheaders.min.js"></script>
<script type="text/javascript" src="https://brettviren.github.io/moo/other/readtheorg/js/readtheorg.js"></script>
<style> #content{max-width:1800px;}</style>
<style> p{max-width:800px;}</style>
<style> li{max-width:800px;}</style>
<style> pre.src{border-radius: 5px; background-color:#333; color:#0f0;}</style>
<style> pre.example{border-radius: 5px; background-color:#333; color:#0f0;}</style>
<style> code{border-radius: 5px; background-color:#333; color:#0f0;}</style>
<script type="text/javascript">
// @license magnet:?xt=urn:btih:e95b018ef3580986a04669f1b5879592219e2a7a&dn=public-domain.txt Public Domain
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.classList.add("code-highlighted");
target.classList.add("code-highlighted");
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.classList.remove("code-highlighted");
target.classList.remove("code-highlighted");
}
}
/*]]>*///-->
// @license-end
</script>
</head>
<body>
<div id="content">
<h1 class="title">Calculate electrical response induced by drifting charge</h1>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#orgd25e5dc">Introduction</a></li>
<li><a href="#orgf6b8419">Install</a></li>
<li><a href="#org7cfb998">Usage</a></li>
<li><a href="#org7693be6">Documentation</a></li>
</ul>
</div>
</div>
<div id="outline-container-orgd25e5dc" class="outline-2">
<h2 id="orgd25e5dc">Introduction</h2>
<div class="outline-text-2" id="text-orgd25e5dc">
<p>
This package solves Laplace, initial value and other problems in order
to produce the current response on electrodes due to drifting of
nearby charge.
</p>
<p>
About the name: the core Laplace problems are solved in <code>pochoir</code> with
the finite-difference method (FDM). The core operation of FDM is
sometimes described as a "stencil" convolution. The name <i>pochoir</i>
describes a stencil-based art style. No constraint is intended on
your personal <a href="https://www.google.com/search?q=pronounce+pochoir">pronunciation of "pochoir"</a>.
</p>
</div>
</div>
<div id="outline-container-orgf6b8419" class="outline-2">
<h2 id="orgf6b8419">Install</h2>
<div class="outline-text-2" id="text-orgf6b8419">
<p>
<code>pochoir</code> installs in the "usual Python way". Use of <code>pip</code> and a Python
virtual environment is recommended.
</p>
<pre class="example" id="org9b76b15">
python3 -m venv venv
source venv/bin/activiate
</pre>
<p>
Or maybe you prefer <code>direnv</code>
</p>
<pre class="example" id="org8558b10">
echo layout python3 > .envrc
direnv allow
</pre>
<p>
To install the base support (no support for GPU, plots, config)
</p>
<pre class="example" id="org37a86a1">
pip install git+https://github.com/brettviren/pochoir.git@HEAD
</pre>
<p>
Or for development
</p>
<pre class="example" id="org2d7d21f">
git clone [email protected]:brettviren/pochoir.git
cd pochoir
pip install -e .
</pre>
<p>
A number of "extra" support is included mostly for PyTorch, numba, or
cupy to try to accelerate some bottlenecks on GPU or via
multiprocessing.
</p>
<pre class="example" id="org23c1f99">
pip install -e .[torch,cupy,numba,vtk,plots,hdf5]
</pre>
<p>
Additional setup and of course hardware may be needed to use the GPU
support.
</p>
</div>
</div>
<div id="outline-container-org7cfb998" class="outline-2">
<h2 id="org7cfb998">Usage</h2>
<div class="outline-text-2" id="text-org7cfb998">
<p>
The <code>pochoir</code> command line user interface provides online help:
</p>
<div class="org-src-container">
<pre class="src src-shell">pochoir
</pre>
</div>
<pre class="example" id="org68e5663">
Usage: pochoir [OPTIONS] COMMAND [ARGS]...
pochoir command line interface
Options:
-s, --store PATH File for primary data storage (input and maybe output)
-o, --outstore PATH File for output (primary only input)
--help Show this message and exit.
Commands:
bc-interp Interpolate 2D solution into 3D boundary condition
domain Produce a "domain" and store it to the named dataset.
drift Calculate drift paths.
example Generate a boundary and initial array example (try...
export-vtk-image Export a dataset to a vtk file of same name
fdm Apply finite-difference method.
gen Generate initial and boundary value arrays from a...
gencfg Generate JSON configuration files from master file.
grad Calculate the gradient of a scalar field.
induce Calculate induced current.
init Initialize a problem with a shape file.
ls List the store store
move-paths Move paths along offset vector.
plot-drift Visualize 2D or 3D paths
plot-image Visualize a dataset as 2D image
plot-mag Plot magnitude of a vector field
plot-quiver Visualize a 2D or 3D vector field as a "quiver" plot.
srdot Apply Ramo theorem dot product.
starts Store "starting" points.
velo Calculate a velocity field from a potential field
version Print the version
</pre>
<p>
Of particular note, to avoid having to always provide the <code>-s/--store</code>
option one may set the store via an environment variable:
</p>
<pre class="example" id="orgbce8bfb">
export POCHOIR_STORE=/path/to/store
</pre>
<p>
Individual commands provide more details on their use:
</p>
<div class="org-src-container">
<pre class="src src-shell">pochoir fdm --help
</pre>
</div>
<pre class="example" id="orgd24abcb">
Usage: pochoir fdm [OPTIONS]
Apply finite-difference method.
Solve Laplace equation given initial/boundary value arrays to produce a
scalar potential array.
Options:
-i, --initial TEXT Input initial value array
-b, --boundary TEXT Input the boundary array
-e, --edges TEXT Comma separated list of 'fixed' or
'periodic' giving domain edge conditions
--precision FLOAT Finish when no changes larger than precision
--epoch INTEGER Number of iterations before any check
-n, --nepochs INTEGER Limit number of epochs (def: one epoch)
--engine [numpy|numba|torch|cupy|cumba]
The FDM engine to use
-P, --potential TEXT Output array holding solution for potential
-I, --increment TEXT Output array holding increment (error) on
the solution
--help Show this message and exit.
</pre>
</div>
</div>
<div id="outline-container-org7693be6" class="outline-2">
<h2 id="org7693be6">Documentation</h2>
<div class="outline-text-2" id="text-org7693be6">
<p>
The <code>pochoir</code> command attempts to be simple and accessible. However,
the calculation it performs is not trivial and has many steps. A user
must understand these steps and what <code>pochoir</code> requires.
</p>
<p>
The documentation to describe these details is in development. For
now see:
</p>
<ul class="org-ul">
<li><a href="./overview.html">./overview.html</a> gives a conceptual description of the steps that
<code>pochoir</code> calculates.</li>
<li><a href="./test/test-sandh2d.html">./test/test-sandh2d.html</a> a walk through of a full-chain solving a
simplified, purely 2D problem.</li>
</ul>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="author">Author: Brett Viren</p>
<p class="date">Created: 2021-05-20 Thu 13:19</p>
<p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
</html>