Name: 'Your real name'
Legi-Nr: 'Your legi number'
Email: 'Your email address'
Carefully follow the instructions below to setup your assignment repository.
Assignment 1 (Due date: 10.03.2023 10:00)
Copying code (either from other students or from external sources) is strictly prohibited! We will be using automatic anti-plagiarism tools, and any violation of this rule will lead to expulsion from the class. Late submissions will generally not be accepted. In case of serious illness or emergency, please send an e-mail to igl.lectures@inf.ethz.ch and provide a relevant medical certificate.
We explicitly ask you to not create any public repositories containing copies of these assignments or solutions to them. In any case do not include any terms that are identifiably related to this course and make the repository easily searchable.
For each assignment, you will use the geometry processing library libigl, which includes implementations of many of the algorithms presented in class. The libigl library includes a set of tutorials, an introduction which can be found online. You are advised to look over the relevant tutorials before starting the implementation for the assignments; you are also encouraged to examine the source code of all the library functions that you use in your code to see how they were implemented. To simplify compilation, we will use libigl as a header-only library (note that, if you prefer, you can compile it into a set of static libraries for faster builds at your own risk (this can be brittle on some platforms). All the library dependencies of the assignemnts (e.g. libigl, Eigen, imgui) will be downloaded automatically when the project is configured (via cmake). No libraries apart from those are permitted unless stated otherwise.
Before we can begin, you must have Git running, a distributed revision control system which you need to handin your assignments as well as keeping track of your code changes. We refer you to the online Pro Git book for more information. There you will also find instructions on how to to install it. On Windows we suggest using git for windows.
CMake is the system libigl uses for cross-platform builds. If you are using Linux or macOS, we recommend installing it with a package manager instead of the CMake download page. E.g. on Debian/Ubuntu:
sudo apt-get install cmake
or with MacPorts on macOS:
sudo port install cmake.
On Windows you can download it from: https://cmake.org/download/
Before you are able to clone your private assignment repository, you need to have a active Github account. Then you can create your own private online repository by following this link: https://classroom.github.com/a/J6orIqlZ
In the next step you need to clone it to your local harddrive
git clone --recursive https://github.com/eth-igl/gp23-'Your_Git_Username'.git
'Your_Git_Username' needs to be replaced accordingly. This can take a moment.
Next, cd into the newly created folder, and add the base assignment repository as a remote:
cd gp23-'Your_Git_Username'
git remote add base https://github.com/eth-igl/GP2023-Assignments.git
git pull base main --allow-unrelated-histories
Now you should have your local clone of the assignment repository ready. Have a look at the new repository folder and open the 'README.md'. It contains the text you are just reading. Please fill in your name and student number at the top of this file and save. Then you need to stage and commit this changed file:
git add README.md
git commit -m "Adjust README.md"
git push
You should now be able to see your name online on your private repository: https://github.com/eth-igl/gp23-'Your_Git_Username'
In the assignment repository you will find the different assignment directories 'assignmentX'. For now you only see the first one 'assignment1'. To compile the assignment code we will use the CMake building system.
Create a directory called build in the assignment directory, e.g.:
cd assignment1; mkdir build
Use CMake to generate the Makefiles needed for compilation inside the build/ directory:
cd build; cmake -DCMAKE_BUILD_TYPE=Release ../
On windows use the CMAKE GUI with the buttons Configure and Generate.
Compile and run the executable, e.g.:
make -j && ./assignment1 <some mesh file>
Or use your favorite IDE.
Please compile your final code in Release mode for optimal speed, and use Debug mode to debug your code.
If you encounter any problems, please create a post on the course Moodle or ask the assistant in the exercise session.
In general, you should use Git to commit your edits as often as possible. This will help you with backtracking bugs and also serve as a backup mechanism. For more information we refer you to the Pro Git book.
Every new assignment needs to be pulled from the base repository:
git pull base main
or,
git pull base main --allow-unrelated-histories
In every assignment directory you will find a 'README.md' file in which we will specify the required screenshots and console outputs. You should briefly summarize and report your results and observations, or discuss possible problems. For a quick introduction of the Markdown syntax see: https://guides.github.com/features/mastering-markdown/
To submit your solution of the assignment please add the following commit message: "Solution assignment X". E.g:
git commit -m "Solution assignment X"
git push
Please make sure your code compiles on either Unix or Windows. You can keep updating your code before the deadline. After the deadline, please don't change the code of that assignment before we send you the scores.
Please use the course Moodle to post your questions and discussions about the assignments. We will try to answer your questions as soon as possible, while all students are encouraged to address these questions to help their fellows. Please make sure your question is not a duplicate before submitting it.
The solutions must be submitted before the deadlines mentioned in the assignment sheet and on the course website (we will check the git commit timestamp). Late submissions will not be accepted.