Skip to content

Commit b8b6cd2

Browse files
joergbuchwaldjoergbuchwald
committed
update docs
1 parent d839ed4 commit b8b6cd2

File tree

106 files changed

+26597
-21
lines changed

Some content is hidden

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

106 files changed

+26597
-21
lines changed

Diff for: ‎README_julia.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ vtufile = vtuIO.VTUIO("examples/square_1e2_pcs_0_ts_1_t_1.000000.vtu", dim=2)
2727

2828

2929

30-
PyObject <vtuIO.VTUIO object at 0x7fe66e250760>
30+
PyObject <vtuIO.VTUIO object at 0x7f3ccc65a760>
3131

3232

3333

@@ -36,7 +36,7 @@ Basic VTU properties, like fieldnames, points and corresponding fielddata as pro
3636

3737

3838
```julia
39-
fields=vtufile.get_field_names()
39+
fields=vtufile.get_point_field_names()
4040
```
4141

4242

@@ -67,7 +67,7 @@ vtufile.points[1:3]
6767

6868

6969
```julia
70-
vtufile.get_field("v")
70+
vtufile.get_point_field("v")
7171
```
7272

7373

@@ -150,13 +150,13 @@ vtufile = vtuIO.VTUIO("examples/square2d_random.vtu", dim=2)
150150

151151

152152

153-
PyObject <vtuIO.VTUIO object at 0x7fe65b8f20d0>
153+
PyObject <vtuIO.VTUIO object at 0x7f3ccc652220>
154154

155155

156156

157157

158158
```julia
159-
field = vtufile.get_field("gaussian_field_2");
159+
field = vtufile.get_point_field("gaussian_field_2");
160160
```
161161

162162

@@ -167,7 +167,7 @@ triang = matplotlib.tri.Triangulation(vtufile.points[:,1], vtufile.points[:,2])
167167

168168

169169

170-
PyObject <matplotlib.tri.triangulation.Triangulation object at 0x7fe61648f370>
170+
PyObject <matplotlib.tri.triangulation.Triangulation object at 0x7f3c7b057670>
171171

172172

173173

@@ -185,7 +185,7 @@ tricontourf(triang,field)
185185

186186

187187

188-
PyObject <matplotlib.tri.tricontour.TriContourSet object at 0x7fe6142ed640>
188+
PyObject <matplotlib.tri.tricontour.TriContourSet object at 0x7f3c76b14790>
189189

190190

191191

@@ -236,7 +236,7 @@ legend()
236236

237237

238238

239-
PyObject <matplotlib.legend.Legend object at 0x7fe66e381880>
239+
PyObject <matplotlib.legend.Legend object at 0x7f3cccb83520>
240240

241241

242242

@@ -251,13 +251,13 @@ vtufile = vtuIO.VTUIO("examples/square_1e2_pcs_0_ts_1_t_1.000000.vtu", dim=2)
251251

252252

253253

254-
PyObject <vtuIO.VTUIO object at 0x7fe66e3b7760>
254+
PyObject <vtuIO.VTUIO object at 0x7f3cccbb9190>
255255

256256

257257

258258

259259
```julia
260-
p_size = length(vtufile.get_field("pressure"))
260+
p_size = length(vtufile.get_point_field("pressure"))
261261
```
262262

263263

@@ -329,13 +329,13 @@ Similar to reading VTU files, it is possible extract time series data from a lis
329329

330330

331331
```julia
332-
pvdfile = vtuIO.PVDIO("examples", "square_1e2_pcs_0.pvd", dim=2)
332+
pvdfile = vtuIO.PVDIO("examples/square_1e2_pcs_0.pvd", dim=2)
333333
```
334334

335335

336336

337337

338-
PyObject <vtuIO.PVDIO object at 0x7fe66e3c9b50>
338+
PyObject <vtuIO.PVDIO object at 0x7f3cccbf1550>
339339

340340

341341

@@ -491,7 +491,7 @@ legend()
491491

492492

493493

494-
PyObject <matplotlib.legend.Legend object at 0x7fe600cb4100>
494+
PyObject <matplotlib.legend.Legend object at 0x7f3c5f4d19d0>
495495

496496

497497

Diff for: ‎README_python.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Basic VTU properties, like fieldnames, points and corresponding fielddata as pro
1717

1818

1919
```python
20-
vtufile.get_field_names()
20+
vtufile.get_point_field_names()
2121
```
2222

2323

@@ -45,7 +45,7 @@ vtufile.points[0:3]
4545

4646

4747
```python
48-
vtufile.get_field("v")[0:3]
48+
vtufile.get_point_field("v")[0:3]
4949
```
5050

5151

@@ -93,7 +93,7 @@ vtufile = vtuIO.VTUIO("examples/square2d_random.vtu", dim=2)
9393

9494

9595
```python
96-
field = vtufile.get_field("gaussian_field_2");
96+
field = vtufile.get_point_field("gaussian_field_2");
9797
```
9898

9999

@@ -109,7 +109,7 @@ plt.tricontourf(triang,field)
109109

110110

111111

112-
<matplotlib.tri.tricontour.TriContourSet at 0x7f84fa66b670>
112+
<matplotlib.tri.tricontour.TriContourSet at 0x7f81305deac0>
113113

114114

115115

@@ -164,7 +164,7 @@ plt.legend()
164164

165165

166166

167-
<matplotlib.legend.Legend at 0x7f84fa629220>
167+
<matplotlib.legend.Legend at 0x7f81302c1e80>
168168

169169

170170

@@ -184,7 +184,7 @@ vtufile = vtuIO.VTUIO("examples/square_1e2_pcs_0_ts_1_t_1.000000.vtu", dim=2)
184184

185185

186186
```python
187-
p_size = len(vtufile.get_field("pressure"))
187+
p_size = len(vtufile.get_point_field("pressure"))
188188
```
189189

190190

@@ -228,7 +228,7 @@ Similar to reading VTU files, it is possible extract time series data from a lis
228228

229229

230230
```python
231-
pvdfile = vtuIO.PVDIO("examples", "square_1e2_pcs_0.pvd", dim=2)
231+
pvdfile = vtuIO.PVDIO("examples/square_1e2_pcs_0.pvd", dim=2)
232232
```
233233

234234
examples/square_1e2_pcs_0.pvd
@@ -324,7 +324,7 @@ plt.legend()
324324

325325

326326

327-
<matplotlib.legend.Legend at 0x7f84fa491c10>
327+
<matplotlib.legend.Legend at 0x7f8130186850>
328328

329329

330330

Diff for: ‎docs/_build/doctrees/api.doctree

69 KB
Binary file not shown.

Diff for: ‎docs/_build/doctrees/basic_usage_julia.doctree

27.4 KB
Binary file not shown.

Diff for: ‎docs/_build/doctrees/basic_usage_python.doctree

22 KB
Binary file not shown.

Diff for: ‎docs/_build/doctrees/changelog.doctree

4.09 KB
Binary file not shown.

Diff for: ‎docs/_build/doctrees/contents.doctree

2.37 KB
Binary file not shown.

Diff for: ‎docs/_build/doctrees/environment.pickle

29.9 KB
Binary file not shown.

Diff for: ‎docs/_build/doctrees/index.doctree

11.3 KB
Binary file not shown.

Diff for: ‎docs/_build/html/.buildinfo

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 695e23504c8cbb7acb81acb7ed5c4fbc
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

Diff for: ‎docs/_build/html/_sources/api.rst.txt

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. VTUinterface documentation master file, created by
2+
sphinx-quickstart on Tue May 11 22:57:26 2021.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
VTUinterface API reference documentation!
7+
=========================================
8+
9+
.. automodule:: VTUinterface.vtuIO
10+
:members:
11+
:undoc-members:
12+
:show-inheritance:
13+
14+
15+
.. toctree::
16+
:maxdepth: 2
17+
:caption: Contents:
18+
19+
.. raw:: latex
20+
21+
\clearpage
22+
23+
24+
Indices and tables
25+
==================
26+
27+
* :ref:`genindex`
28+
* :ref:`modindex`
29+
* :ref:`search`

Diff for: ‎docs/_build/html/_sources/basic_usage_julia.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. mdinclude:: ../README_julia.md

Diff for: ‎docs/_build/html/_sources/basic_usage_python.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. mdinclude:: ../README_python.md

Diff for: ‎docs/_build/html/_sources/changelog.rst.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.. mdinclude:: ../CHANGELOG.md
2+

Diff for: ‎docs/_build/html/_sources/contents.rst.txt

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. toctree::
2+
:maxdepth: 3
3+
4+
index
5+
basic_usage_python
6+
basic_usage_julia
7+
api
8+
changelog
9+

Diff for: ‎docs/_build/html/_sources/index.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. mdinclude:: ../README.md

0 commit comments

Comments
 (0)