A July 2020 VTK Hackathon

Feel free to experiment with VTKEx with the corresponding site: VTKEx Site. It is a mirror of Bill’s VTK Examples site with a lot of updates to the scripting and instructions.

I have rewritten the scripts and instructions so that (I hope!), the only changes needed to generate new web pages if we move to a new repository are in:

  • mkdocs.yml : Modify site names, username etc.

  • src/SyncSiteWithRepo.sh : Run with the new repository name and the local VTK folder

  • src/Admin/ScrapeRepo.py : Line 757 in the function: make_instruction_pages(…) would need to be modified for GitLab.

We have to move to a new site as I only have administrator access to the original VTKExamples site. So I can update the master but that is all, since I have no password access. Another reason for moving the site is that the tarballs for the C++ examples are written to a different site to which I have no access.

So this updated mirror VTKEx will do the job.

If you checkout VTKEx and want to try building a site, I would recommend uncommenting lines 72/73 in src/SyncSiteWithRepo.sh. This will mean that the repository is not updated. Thus you can go to the site folder and test it out on your local machine.

One thing we should consider in relation to the chapter files (e.g. src/Cxx.md ) is the removal of the Classes Demonstrated column as this data is in the coverage files. This column existed before I wrote the coverage scripts and was used to point out the classes used. Something to think about.

Just a passing thought, the VTK web pages could link to src/Coverage/CxxVTKClassesUsed.md and src/Coverage/PythonVTKClassesUsed.md, these markdown files tie together the VTK classes with the examples. So people using the VTK web pages, aside from having access to the tests, will have a link to examples.