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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
|
%global _empty_manifest_terminate_build 0
Name: python-dash-vtk
Version: 0.0.9
Release: 1
Summary: React based declarative usage of vtk.js for Dash
License: MIT
URL: https://github.com/plotly/dash-vtk
Source0: https://mirrors.aliyun.com/pypi/web/packages/e9/56/2489ae0e422c201baa12adbd331f8d2408063fc156a405f86617a4147aef/dash_vtk-0.0.9.tar.gz
BuildArch: noarch
Requires: python3-dash
Requires: python3-vtk
%description
# Dash VTK
*Dash VTK lets you integrate the `vtk.js` visualization pipeline directly into your Dash app. It is powered by [`react-vtk-js`](https://github.com/Kitware/react-vtk-js/).*
| ![][usage-algorithm] | ![][pyvista-point-cloud] | ![][terrain-deformation] |
| --- | --- | --- |
| ![][volume-rendering] | ![][vtk-cfd] | ![][synthetic-volume] |
* [Docs](https://github.com/plotly/dash-vtk/tree/master/docs)
* [Demo Explorer](https://dash-gallery.plotly.host/dash-vtk-explorer/)
* [Repository](https://github.com/plotly/dash-vtk)
* [Webinar](https://go.plotly.com/dash-vtk)
## Getting started
### Quickstart (Python)
First, install the library through `pip`:
```
pip install dash-vtk
```
Then, create a file called `app.py` and add the following example:
```python
import dash
import dash_vtk
import dash_html_components as html
app = dash.Dash(__name__)
app.layout = html.Div(
style={"width": "100%", "height": "calc(100vh - 16px)"},
children=dash_vtk.View([
dash_vtk.GeometryRepresentation([
dash_vtk.Algorithm(
vtkClass="vtkConeSource",
state={"resolution": 64, "capping": False},
)
]),
]),
)
if __name__ == "__main__":
app.run_server(debug=True)
```
Now, simply run the app:
```
python app.py
```
For a more detailed example, see `usage.py`.
### Quickstart (R)
First, install the package from GitHub (the package is not yet available via CRAN):
```
remotes::install_github("plotly/dash-vtk")
```
then, create your component and add it to your layout:
```r
library(dash)
library(dashVtk)
library(dashHtmlComponents)
app <- Dash$new()
app$layout(htmlDiv(
style = list("width" = "100%", "height" = "calc(100vh - 16px)"),
children = vtkView(list(
vtkGeometryRepresentation(
vtkAlgorithm(
vtkClass = "vtkConeSource",
state = list("resolution" = 64, "capping" = FALSE),
)
)
)
)
app$run_server()
```
## Contributing
See [docs/CONTRIBUTING.md](./docs/CONTRIBUTING.md) to learn about:
* Setting up the environment
* Coding Style
* Code quality & design
* Tests
* Publishing
## Running the demos
First clone the project (replace `<name>` with the desired demo):
``` bash
git clone https://github.com/plotly/dash-vtk.git
cd dash-vtk/demos/<name>/
```
Create a venv and install the requirements:
```bash
python -m venv venv
source venv/bin/activate # for Windows, use venv\Scripts\activate.bat
pip install -e ../../ # IMPORTANT! If you skip you will get the pip version of dash-vtk
pip install -r requirements.txt
```
Run the demo:
```bash
python app.py
```
### Python environments
Depending on your Python environment, you may run into deployment issue related to the vtk version that get pulled in.
Ideally we want a version of vtk equal or newer than 9. When using such version of VTK, `dash-vtk` won't even try to load the rendering module of VTK and if OpenGL is not available on your system everything will still be fine.
On the other hand, if you are running python-3.6 and/or pip-18 or less and you don't upgrade your pip version, you will only be able to use `vtk<=8.1.2`. With vtk 8, there is no way to prevent the loading of the GL library which means that you will have to install libGL on your system, or you will run into errors like this:
```
File ".../python/lib/python3.6/site-packages/vtkmodules/all.py", line 29, in <module>
from .vtkRenderingOpenGL2 import *
ImportError: libGL.so.1: cannot open shared object file: No such file or directory
[2021-02-08 18:36:15 +0000] [10] [INFO] Worker exiting (pid: 10)
```
or this:
```
File ".../python3.7/site-packages/vtk/__init__.py", line 12, in <module>
from .vtkOpenGLKit import *
File ".../python3.7/site-packages/vtk/vtkOpenGLKit.py", line 9, in <module>
from vtkOpenGLKitPython import *
ModuleNotFoundError: No module named 'vtkOpenGLKitPython'
```
Heroku and Dash Enterprise handle it is slightly different because you will have to install `libgl1-mesa-glx` via some `apt` files. In the case of Heroku, you will have to use a [buildpack](https://elements.heroku.com/buildpacks/heroku/heroku-buildpack-apt) and add `libgl1-mesa-glx` to a `Aptfile` located in the root of your project. In the case of Dash Enterprise, you do not need to change the buildpack (it is handled automatically) but you will need to add `libgl1-mesa-glx` to a `apt-packages` file instead of `Aptfile`; see [this app](https://github.com/plotly/dash-sample-apps/blob/master/apps/dash-vtk-explorer/apt-packages) as an example.
## References
You can find the complete API reference in [`docs/REFERENCES.md`](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md) for each of the following components:
- [Algorithm](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#Algorithm)
- [Calculator](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#Calculator)
- [CellData](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#CellData)
- [DataArray](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#DataArray)
- [FieldData](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#FieldData)
- [GeometryRepresentation](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#GeometryRepresentation)
- [ImageData](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#ImageData)
- [PointCloudRepresentation](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#PointCloudRepresentation)
- [PointData](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#PointData)
- [PolyData](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#PolyData)
- [Reader](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#Reader)
- [ShareDataSet](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#ShareDataSet)
- [SliceRepresentation](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#SliceRepresentation)
- [View](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#View)
- [VolumeController](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#VolumeController)
- [VolumeDataRepresentation](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#VolumeDataRepresentation)
- [VolumeRepresentation](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#VolumeRepresentation)
## Demos
### Usage for `dash_vtk.Algorithm`
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/usage-algorithm)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/usage-algorithm)
![][usage-algorithm]
### Point Cloud with PyVista
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/pyvista-point-cloud)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/pyvista-point-cloud)
![][pyvista-point-cloud]
### Terrain deformation using PyVista and dash-vtk
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/pyvista-terrain-following-mesh)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/pyvista-terrain-following-mesh)
![][terrain-deformation]
### Volume Rendering
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/volume-rendering)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/volume-rendering)
![A demo of the volume-rendering app][volume-rendering]
### VTK for data processing and dash-vtk for rendering
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/usage-vtk-cfd)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/usage-vtk-cfd)
![A demo of the usage-vtk-cfd app][vtk-cfd]
### Synthetic Volume Rendering
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/synthetic-volume-rendering)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/synthetic-volume-rendering)
![A demo of the synthetic-volume-rendering app][synthetic-volume]
[pyvista-point-cloud]: https://github.com/plotly/dash-vtk/blob/master/demos/pyvista-point-cloud/demo.jpg?raw=true
[usage-algorithm]: https://github.com/plotly/dash-vtk/blob/master/demos/usage-algorithm/demo.jpg?raw=true
[terrain-deformation]: https://github.com/plotly/dash-vtk/blob/master/demos/pyvista-terrain-following-mesh/demo.jpg?raw=true
[volume-rendering]: https://github.com/plotly/dash-vtk/blob/master/demos/volume-rendering/demo.jpg?raw=true
[vtk-cfd]: https://github.com/plotly/dash-vtk/blob/master/demos/usage-vtk-cfd/demo.jpg?raw=true
[synthetic-volume]: https://github.com/plotly/dash-vtk/blob/master/demos/synthetic-volume-rendering/demo.jpg?raw=true
[dicom-ct-lung]: https://github.com/plotly/dash-vtk/blob/master/demos/dicom-ct-lung/demo.jpg?raw=true
[dicom-mri-brain]: https://github.com/plotly/dash-vtk/blob/master/demos/dicom-mri-brain/demo.jpg?raw=true
[dicom-mri-pancreas]: https://github.com/plotly/dash-vtk/blob/master/demos/dicom-mri-pancreas/demo.jpg?raw=true
%package -n python3-dash-vtk
Summary: React based declarative usage of vtk.js for Dash
Provides: python-dash-vtk
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-dash-vtk
# Dash VTK
*Dash VTK lets you integrate the `vtk.js` visualization pipeline directly into your Dash app. It is powered by [`react-vtk-js`](https://github.com/Kitware/react-vtk-js/).*
| ![][usage-algorithm] | ![][pyvista-point-cloud] | ![][terrain-deformation] |
| --- | --- | --- |
| ![][volume-rendering] | ![][vtk-cfd] | ![][synthetic-volume] |
* [Docs](https://github.com/plotly/dash-vtk/tree/master/docs)
* [Demo Explorer](https://dash-gallery.plotly.host/dash-vtk-explorer/)
* [Repository](https://github.com/plotly/dash-vtk)
* [Webinar](https://go.plotly.com/dash-vtk)
## Getting started
### Quickstart (Python)
First, install the library through `pip`:
```
pip install dash-vtk
```
Then, create a file called `app.py` and add the following example:
```python
import dash
import dash_vtk
import dash_html_components as html
app = dash.Dash(__name__)
app.layout = html.Div(
style={"width": "100%", "height": "calc(100vh - 16px)"},
children=dash_vtk.View([
dash_vtk.GeometryRepresentation([
dash_vtk.Algorithm(
vtkClass="vtkConeSource",
state={"resolution": 64, "capping": False},
)
]),
]),
)
if __name__ == "__main__":
app.run_server(debug=True)
```
Now, simply run the app:
```
python app.py
```
For a more detailed example, see `usage.py`.
### Quickstart (R)
First, install the package from GitHub (the package is not yet available via CRAN):
```
remotes::install_github("plotly/dash-vtk")
```
then, create your component and add it to your layout:
```r
library(dash)
library(dashVtk)
library(dashHtmlComponents)
app <- Dash$new()
app$layout(htmlDiv(
style = list("width" = "100%", "height" = "calc(100vh - 16px)"),
children = vtkView(list(
vtkGeometryRepresentation(
vtkAlgorithm(
vtkClass = "vtkConeSource",
state = list("resolution" = 64, "capping" = FALSE),
)
)
)
)
app$run_server()
```
## Contributing
See [docs/CONTRIBUTING.md](./docs/CONTRIBUTING.md) to learn about:
* Setting up the environment
* Coding Style
* Code quality & design
* Tests
* Publishing
## Running the demos
First clone the project (replace `<name>` with the desired demo):
``` bash
git clone https://github.com/plotly/dash-vtk.git
cd dash-vtk/demos/<name>/
```
Create a venv and install the requirements:
```bash
python -m venv venv
source venv/bin/activate # for Windows, use venv\Scripts\activate.bat
pip install -e ../../ # IMPORTANT! If you skip you will get the pip version of dash-vtk
pip install -r requirements.txt
```
Run the demo:
```bash
python app.py
```
### Python environments
Depending on your Python environment, you may run into deployment issue related to the vtk version that get pulled in.
Ideally we want a version of vtk equal or newer than 9. When using such version of VTK, `dash-vtk` won't even try to load the rendering module of VTK and if OpenGL is not available on your system everything will still be fine.
On the other hand, if you are running python-3.6 and/or pip-18 or less and you don't upgrade your pip version, you will only be able to use `vtk<=8.1.2`. With vtk 8, there is no way to prevent the loading of the GL library which means that you will have to install libGL on your system, or you will run into errors like this:
```
File ".../python/lib/python3.6/site-packages/vtkmodules/all.py", line 29, in <module>
from .vtkRenderingOpenGL2 import *
ImportError: libGL.so.1: cannot open shared object file: No such file or directory
[2021-02-08 18:36:15 +0000] [10] [INFO] Worker exiting (pid: 10)
```
or this:
```
File ".../python3.7/site-packages/vtk/__init__.py", line 12, in <module>
from .vtkOpenGLKit import *
File ".../python3.7/site-packages/vtk/vtkOpenGLKit.py", line 9, in <module>
from vtkOpenGLKitPython import *
ModuleNotFoundError: No module named 'vtkOpenGLKitPython'
```
Heroku and Dash Enterprise handle it is slightly different because you will have to install `libgl1-mesa-glx` via some `apt` files. In the case of Heroku, you will have to use a [buildpack](https://elements.heroku.com/buildpacks/heroku/heroku-buildpack-apt) and add `libgl1-mesa-glx` to a `Aptfile` located in the root of your project. In the case of Dash Enterprise, you do not need to change the buildpack (it is handled automatically) but you will need to add `libgl1-mesa-glx` to a `apt-packages` file instead of `Aptfile`; see [this app](https://github.com/plotly/dash-sample-apps/blob/master/apps/dash-vtk-explorer/apt-packages) as an example.
## References
You can find the complete API reference in [`docs/REFERENCES.md`](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md) for each of the following components:
- [Algorithm](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#Algorithm)
- [Calculator](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#Calculator)
- [CellData](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#CellData)
- [DataArray](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#DataArray)
- [FieldData](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#FieldData)
- [GeometryRepresentation](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#GeometryRepresentation)
- [ImageData](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#ImageData)
- [PointCloudRepresentation](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#PointCloudRepresentation)
- [PointData](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#PointData)
- [PolyData](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#PolyData)
- [Reader](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#Reader)
- [ShareDataSet](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#ShareDataSet)
- [SliceRepresentation](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#SliceRepresentation)
- [View](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#View)
- [VolumeController](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#VolumeController)
- [VolumeDataRepresentation](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#VolumeDataRepresentation)
- [VolumeRepresentation](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#VolumeRepresentation)
## Demos
### Usage for `dash_vtk.Algorithm`
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/usage-algorithm)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/usage-algorithm)
![][usage-algorithm]
### Point Cloud with PyVista
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/pyvista-point-cloud)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/pyvista-point-cloud)
![][pyvista-point-cloud]
### Terrain deformation using PyVista and dash-vtk
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/pyvista-terrain-following-mesh)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/pyvista-terrain-following-mesh)
![][terrain-deformation]
### Volume Rendering
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/volume-rendering)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/volume-rendering)
![A demo of the volume-rendering app][volume-rendering]
### VTK for data processing and dash-vtk for rendering
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/usage-vtk-cfd)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/usage-vtk-cfd)
![A demo of the usage-vtk-cfd app][vtk-cfd]
### Synthetic Volume Rendering
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/synthetic-volume-rendering)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/synthetic-volume-rendering)
![A demo of the synthetic-volume-rendering app][synthetic-volume]
[pyvista-point-cloud]: https://github.com/plotly/dash-vtk/blob/master/demos/pyvista-point-cloud/demo.jpg?raw=true
[usage-algorithm]: https://github.com/plotly/dash-vtk/blob/master/demos/usage-algorithm/demo.jpg?raw=true
[terrain-deformation]: https://github.com/plotly/dash-vtk/blob/master/demos/pyvista-terrain-following-mesh/demo.jpg?raw=true
[volume-rendering]: https://github.com/plotly/dash-vtk/blob/master/demos/volume-rendering/demo.jpg?raw=true
[vtk-cfd]: https://github.com/plotly/dash-vtk/blob/master/demos/usage-vtk-cfd/demo.jpg?raw=true
[synthetic-volume]: https://github.com/plotly/dash-vtk/blob/master/demos/synthetic-volume-rendering/demo.jpg?raw=true
[dicom-ct-lung]: https://github.com/plotly/dash-vtk/blob/master/demos/dicom-ct-lung/demo.jpg?raw=true
[dicom-mri-brain]: https://github.com/plotly/dash-vtk/blob/master/demos/dicom-mri-brain/demo.jpg?raw=true
[dicom-mri-pancreas]: https://github.com/plotly/dash-vtk/blob/master/demos/dicom-mri-pancreas/demo.jpg?raw=true
%package help
Summary: Development documents and examples for dash-vtk
Provides: python3-dash-vtk-doc
%description help
# Dash VTK
*Dash VTK lets you integrate the `vtk.js` visualization pipeline directly into your Dash app. It is powered by [`react-vtk-js`](https://github.com/Kitware/react-vtk-js/).*
| ![][usage-algorithm] | ![][pyvista-point-cloud] | ![][terrain-deformation] |
| --- | --- | --- |
| ![][volume-rendering] | ![][vtk-cfd] | ![][synthetic-volume] |
* [Docs](https://github.com/plotly/dash-vtk/tree/master/docs)
* [Demo Explorer](https://dash-gallery.plotly.host/dash-vtk-explorer/)
* [Repository](https://github.com/plotly/dash-vtk)
* [Webinar](https://go.plotly.com/dash-vtk)
## Getting started
### Quickstart (Python)
First, install the library through `pip`:
```
pip install dash-vtk
```
Then, create a file called `app.py` and add the following example:
```python
import dash
import dash_vtk
import dash_html_components as html
app = dash.Dash(__name__)
app.layout = html.Div(
style={"width": "100%", "height": "calc(100vh - 16px)"},
children=dash_vtk.View([
dash_vtk.GeometryRepresentation([
dash_vtk.Algorithm(
vtkClass="vtkConeSource",
state={"resolution": 64, "capping": False},
)
]),
]),
)
if __name__ == "__main__":
app.run_server(debug=True)
```
Now, simply run the app:
```
python app.py
```
For a more detailed example, see `usage.py`.
### Quickstart (R)
First, install the package from GitHub (the package is not yet available via CRAN):
```
remotes::install_github("plotly/dash-vtk")
```
then, create your component and add it to your layout:
```r
library(dash)
library(dashVtk)
library(dashHtmlComponents)
app <- Dash$new()
app$layout(htmlDiv(
style = list("width" = "100%", "height" = "calc(100vh - 16px)"),
children = vtkView(list(
vtkGeometryRepresentation(
vtkAlgorithm(
vtkClass = "vtkConeSource",
state = list("resolution" = 64, "capping" = FALSE),
)
)
)
)
app$run_server()
```
## Contributing
See [docs/CONTRIBUTING.md](./docs/CONTRIBUTING.md) to learn about:
* Setting up the environment
* Coding Style
* Code quality & design
* Tests
* Publishing
## Running the demos
First clone the project (replace `<name>` with the desired demo):
``` bash
git clone https://github.com/plotly/dash-vtk.git
cd dash-vtk/demos/<name>/
```
Create a venv and install the requirements:
```bash
python -m venv venv
source venv/bin/activate # for Windows, use venv\Scripts\activate.bat
pip install -e ../../ # IMPORTANT! If you skip you will get the pip version of dash-vtk
pip install -r requirements.txt
```
Run the demo:
```bash
python app.py
```
### Python environments
Depending on your Python environment, you may run into deployment issue related to the vtk version that get pulled in.
Ideally we want a version of vtk equal or newer than 9. When using such version of VTK, `dash-vtk` won't even try to load the rendering module of VTK and if OpenGL is not available on your system everything will still be fine.
On the other hand, if you are running python-3.6 and/or pip-18 or less and you don't upgrade your pip version, you will only be able to use `vtk<=8.1.2`. With vtk 8, there is no way to prevent the loading of the GL library which means that you will have to install libGL on your system, or you will run into errors like this:
```
File ".../python/lib/python3.6/site-packages/vtkmodules/all.py", line 29, in <module>
from .vtkRenderingOpenGL2 import *
ImportError: libGL.so.1: cannot open shared object file: No such file or directory
[2021-02-08 18:36:15 +0000] [10] [INFO] Worker exiting (pid: 10)
```
or this:
```
File ".../python3.7/site-packages/vtk/__init__.py", line 12, in <module>
from .vtkOpenGLKit import *
File ".../python3.7/site-packages/vtk/vtkOpenGLKit.py", line 9, in <module>
from vtkOpenGLKitPython import *
ModuleNotFoundError: No module named 'vtkOpenGLKitPython'
```
Heroku and Dash Enterprise handle it is slightly different because you will have to install `libgl1-mesa-glx` via some `apt` files. In the case of Heroku, you will have to use a [buildpack](https://elements.heroku.com/buildpacks/heroku/heroku-buildpack-apt) and add `libgl1-mesa-glx` to a `Aptfile` located in the root of your project. In the case of Dash Enterprise, you do not need to change the buildpack (it is handled automatically) but you will need to add `libgl1-mesa-glx` to a `apt-packages` file instead of `Aptfile`; see [this app](https://github.com/plotly/dash-sample-apps/blob/master/apps/dash-vtk-explorer/apt-packages) as an example.
## References
You can find the complete API reference in [`docs/REFERENCES.md`](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md) for each of the following components:
- [Algorithm](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#Algorithm)
- [Calculator](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#Calculator)
- [CellData](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#CellData)
- [DataArray](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#DataArray)
- [FieldData](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#FieldData)
- [GeometryRepresentation](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#GeometryRepresentation)
- [ImageData](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#ImageData)
- [PointCloudRepresentation](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#PointCloudRepresentation)
- [PointData](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#PointData)
- [PolyData](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#PolyData)
- [Reader](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#Reader)
- [ShareDataSet](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#ShareDataSet)
- [SliceRepresentation](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#SliceRepresentation)
- [View](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#View)
- [VolumeController](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#VolumeController)
- [VolumeDataRepresentation](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#VolumeDataRepresentation)
- [VolumeRepresentation](https://github.com/plotly/dash-vtk/blob/master/docs/REFERENCES.md#VolumeRepresentation)
## Demos
### Usage for `dash_vtk.Algorithm`
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/usage-algorithm)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/usage-algorithm)
![][usage-algorithm]
### Point Cloud with PyVista
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/pyvista-point-cloud)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/pyvista-point-cloud)
![][pyvista-point-cloud]
### Terrain deformation using PyVista and dash-vtk
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/pyvista-terrain-following-mesh)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/pyvista-terrain-following-mesh)
![][terrain-deformation]
### Volume Rendering
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/volume-rendering)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/volume-rendering)
![A demo of the volume-rendering app][volume-rendering]
### VTK for data processing and dash-vtk for rendering
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/usage-vtk-cfd)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/usage-vtk-cfd)
![A demo of the usage-vtk-cfd app][vtk-cfd]
### Synthetic Volume Rendering
* [Code](https://github.com/plotly/dash-vtk/tree/master/demos/synthetic-volume-rendering)
* [Online Demo](https://dash-gallery.plotly.host/dash-vtk-explorer/synthetic-volume-rendering)
![A demo of the synthetic-volume-rendering app][synthetic-volume]
[pyvista-point-cloud]: https://github.com/plotly/dash-vtk/blob/master/demos/pyvista-point-cloud/demo.jpg?raw=true
[usage-algorithm]: https://github.com/plotly/dash-vtk/blob/master/demos/usage-algorithm/demo.jpg?raw=true
[terrain-deformation]: https://github.com/plotly/dash-vtk/blob/master/demos/pyvista-terrain-following-mesh/demo.jpg?raw=true
[volume-rendering]: https://github.com/plotly/dash-vtk/blob/master/demos/volume-rendering/demo.jpg?raw=true
[vtk-cfd]: https://github.com/plotly/dash-vtk/blob/master/demos/usage-vtk-cfd/demo.jpg?raw=true
[synthetic-volume]: https://github.com/plotly/dash-vtk/blob/master/demos/synthetic-volume-rendering/demo.jpg?raw=true
[dicom-ct-lung]: https://github.com/plotly/dash-vtk/blob/master/demos/dicom-ct-lung/demo.jpg?raw=true
[dicom-mri-brain]: https://github.com/plotly/dash-vtk/blob/master/demos/dicom-mri-brain/demo.jpg?raw=true
[dicom-mri-pancreas]: https://github.com/plotly/dash-vtk/blob/master/demos/dicom-mri-pancreas/demo.jpg?raw=true
%prep
%autosetup -n dash_vtk-0.0.9
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-dash-vtk -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Thu Jun 08 2023 Python_Bot <Python_Bot@openeuler.org> - 0.0.9-1
- Package Spec generated
|