Name: 'Your real name'
Legi-Nr: 'Your legi number'
Email: 'Your email address'
Carefully follow the instructions below to setup your assignment repository.
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. libigl relies on its header files for documentation on how to use the functions, so make sure to read those. 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 assignments (e.g. libigl, Eigen, imgui) will be downloaded automatically when the project is configured (via cmake). No libraries apart from those are permitted unless explicitly 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 cmakeor with MacPorts on macOS:
sudo port install cmake.On Windows, please refer to Building Each Assignment (on Windows) for instructions on how to build the assignments.
Before you are able to clone your private assignment repository, you need to have an active Github account. Then you can create your own private online repository by following this link.
Note that GitHub deprecated the password authentication method for Git. We recommend using a personal access token or SSH to authenticate with GitHub when using Git on the command line.
In the next step you need to clone it to your local harddrive if you are using a personal access token:
git clone --recursive https://github.com/eth-igl/gp24-'Your_Git_Username'.gitor if you are using SSH:
git clone --recursive git@github.com:eth-igl/gp24-'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:
# If you are using personal access token
cd gp24-'Your_Git_Username'
git remote add base https://github.com/eth-igl/gp2024-Assignments.git
git pull base main --allow-unrelated-histories# If you are using SSH
cd gp24-'Your_Git_Username'
git remote add base git@github.com:eth-igl/gp2024-Assignments.git
git pull base main --allow-unrelated-historiesNow 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 pushYou should now be able to see your name online on your private repository: https://github.com/eth-igl/gp24-'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.
Here are the instructions to build with command line tools:
Create a build directory in the assignment directory, e.g.:
cd assignment1; mkdir buildUse CMake to generate the Makefiles needed for compilation inside the build directory:
cd build; cmake -DCMAKE_BUILD_TYPE=Release ..Compile and run the executable, e.g.:
make -j && ./assignment1 <some mesh file>Alternatively, you may use your favorite IDE that supports CMake.
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 use github issues or ask the assistants during the exercise session.
Building on Windows is not recommended as the environment setup is not optimized for command line tools. Here is one possible solution that provides a Unix-like environment on Windows:
Install Visual Studio Community and make sure to select the "Desktop development with C++" workload.
Find x64 Native Tools Command Prompt for VS 2022 in the start menu and open it.
Use the following commands to create the build directory and set up the Makefile:
cd assignment1
mkdir build
cd build
cmake -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=Release ..Use the following commands to compile and run the executable:
nmake
.\assignment1.exe <some mesh file>Alternatively, you may use your favorite IDE that supports CMake.
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 use github issues or ask the assistants during 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 mainor,
git pull base main --allow-unrelated-historiesTo reduce compilation times we have create a proxy file for the libigl Viewer that encapsulates viewer-related function calls. You should be able to use viewer-related functions exactly as they appear in the libigl tutorials. If this does not work, please double check that there is a proxy for the function that you are trying to use in the viewer_proxy.cpp file. If there isn't, please add it yourself following the style for pre-existing functions. Try to avoid frequent updates to the two viewer_proxy files, as these will trigger long compilation times.
To submit your solution of the assignment (code) please add the following commit message: "Solution assignment X". E.g:
git commit -m "Solution assignment X"
git pushYou 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 github issues to post your questions and discussions about the assignments. Note that the issue created under your own repository will not be visible to others, so please use the provided link for that.
While we aim to answer as quickly as possible, we cannot always guarantee this and we thus advise you to not wait till the last minute. All students are encouraged to answer questions of their fellows as well. Please make sure your question is not a duplicate before submitting it and tag it with the corresponding label.
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.