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
|
##########
Some Plots
##########
**Plot 1** Does not use doctest syntax:
.. pyvista-plot::
import pyvista
pyvista.Sphere().plot()
**Plot 2** Uses doctest syntax:
.. pyvista-plot::
:format: doctest
>>> import pyvista
>>> pyvista.Cube().plot()
**Plot 3** Shows that a new block with context does not see the variable defined
in the no-context block:
.. pyvista-plot::
:context:
assert 'a' not in globals()
**Plot 4** Defines ``a`` in a context block:
.. pyvista-plot::
:context:
a = 10
import pyvista
pyvista.Plane().plot()
**Plot 5** Shows that a block with context sees the new variable. It also uses
``:nofigs:``:
.. pyvista-plot::
:context:
:nofigs:
assert a == 10
**Plot 6** Shows that a non-context block still doesn't have ``a``:
.. pyvista-plot::
assert 'a' not in globals()
**Plot 7** Uses ``include-source``:
.. pyvista-plot::
:include-source: True
# Only a comment
Plot _ Uses an external file with the plot commands and a caption:
.. pyvista-plot:: plot_cone.py
:force_static:
This is the caption for plot 8.
Plot _ Uses a specific function in a file with plot commands:
.. pyvista-plot:: plot_polygon.py plot_poly
**Plot 8** Gets a caption specified by the ``:caption:`` option:
.. pyvista-plot::
:force_static:
:caption: Plot 8 uses the caption option.
import pyvista
pyvista.Disc().plot()
Plot __ Uses an external file with the plot commands and a caption
using the ``:caption:`` option:
.. pyvista-plot:: plot_cone.py
:force_static:
:caption: This is the caption for plot_cone.py
**Plot 9** Shows that the default template correctly prints the multi-image
scenario:
.. pyvista-plot::
:force_static:
:caption: This caption applies to both plots.
import pyvista
pyvista.Text3D('hello').plot()
pyvista.Text3D('world').plot()
**Plot 10** Uses the skip directive and should not generate a plot:
.. pyvista-plot::
import pyvista
pyvista.Sphere().plot() # doctest:+SKIP
**Plot 11** Uses ``:include-source: False``:
.. pyvista-plot::
:include-source: False
# you should not be reading this right now
**Plot 12** Uses ``:include-source:`` with no args:
.. pyvista-plot::
:include-source:
# should be printed: include-source with no args
**Plot 13** Should create two plots and be able to plot while skipping
lines, even in two sections:
.. pyvista-plot::
>>> import pyvista
>>> pyvista.Sphere().plot(color='blue', cpos='xy')
>>> pyvista.Sphere().plot(color='red', cpos='xy')
**Plot 14** Forces two static images instead of interactive scenes:
.. pyvista-plot::
:force_static:
>>> import pyvista
>>> pyvista.Sphere().plot(color='blue', cpos='xy')
>>> pyvista.Sphere().plot(color='red', cpos='xy')
**Plot 15** Uses caption with tabbed UI:
.. pyvista-plot::
:caption: Plot 15 uses the caption option with tabbed UI.
import pyvista
pyvista.Disc().plot()
**Plot 16** Should never be skipped, using the ``:skip: no`` option:
.. pyvista-plot::
:skip: no
:caption: Plot 16 will never be skipped
import pyvista
pyvista.Cube().plot()
This plot will always be skipped, using the ``:skip: yes`` option,
but the source will always be included but with no caption:
.. pyvista-plot::
:skip: yes
:caption: This plot will always be skipped with no caption
# should be printed: skip is enforced
**Plot 18** Conditional plot execution using ``:optional:`` option,
but the source will always be included with a conditional caption:
.. pyvista-plot::
:optional:
:caption: This plot may be skipped with no caption
import pyvista
pyvista.Cube().plot()
**Plot 19** Shows a ``matplotlib`` plot to to show that both plot directives
can coexist.
.. plot::
:caption: This is a matplotlib plot.
import matplotlib.pyplot as plt
import numpy as np
x = np.linspace(0, 2*np.pi)
plt.plot(x, np.sin(x))
plt.show()
**Plot 20** Make a plotter but do not show it. An image should not be generated.
.. pyvista-plot::
>>> import pyvista as pv
>>> pl = pv.Plotter()
**Plot 21** The directive also works with plotting methods like ``plot_cell``.
.. pyvista-plot::
from pyvista.examples.cells import Wedge, plot_cell
plot_cell(Wedge())
**Plot 22** This example tests that the 'plot' term in 'tecplot' doesn't break the directive.
.. pyvista-plot::
>>> from pyvista import examples
>>> mesh = examples.download_tecplot_ascii()
>>> mesh.plot()
**Plot 23** Create a gif.
.. pyvista-plot::
import pyvista as pv
from pyvista import examples
filename = examples.download_single_sphere_animation(load=False)
reader = pv.PVDReader(filename)
plotter = pv.Plotter()
plotter.open_gif('single_sphere.gif')
for time_value in reader.time_values:
reader.set_active_time_value(time_value)
mesh = reader.read()
plotter.add_mesh(mesh, smooth_shading=True)
plotter.write_frame()
plotter.clear()
plotter.close()
**Plot 24** Any function with ``plot_<...>`` syntax will generate a plot.
.. pyvista-plot::
>>> from pyvista import demos
>>> demos.plot_ants_plane()
**Plot 25** Methods with ``plot=True`` keywords will also generate a plot.
.. pyvista-plot::
>>> import pyvista as pv
>>> sphere = pv.Sphere()
>>> sphere.ray_trace([0, 0, 0], [1, 0, 0], plot=True)
|