On Board Prep
On Board Preparation
-
Before cloning our repo, you'll need to have VTK installed. VTK is the 3D toolkit we used to help create our desktop application.
-
The best way to get VTK to properly run with python would be to download python(x,y). Please note that you will have to uninstall any previous versions of python completely to run python(x,y) without issues. After you successfully download the executable before you install it on your machine, make sure to select VTK 6.2.0 seen in this
.
-
After you install python(x,y) you can move on to cloning our repo here
-
You can create another python file to make your edits but make sure to import that properly in our UI.py
.-
The biggest hurdle you'll most likely have is understanding how to use VTK. For everything else you can look at python documentation here for Python 2.7.
-
Please take a look at this extensive VTK user guide for any technical issues you may have and how to implement it into our project. (This guide is more of a reference in case you have trouble understanding some aspects of VTK.)
-
VTK is mostly written in C++ but it wraps well with Python and you can see some examples of VTK here. The examples shown are in C++, Java, and Python. These examples are probably going to be the most helpful thing for you to better understand VTK.
We've commented most of our code to help you better understand what's going on if you want to read through everything. Based on the task you were assigned in class your primary contact will be the person who created the issue on Github and that is who you should assign as the code reviewer. You can contact us via our public ryver channel.