This project provides a powerful interface to run particle simulations. The current version of the project is fairly limited in features, however optimizations and support for more complex particle simulations are to come.

To contribute or build the project locally, first run the build.sh file. This will setup CMake, create the Makefile and run the help message of the project. You can find the code documentation of the master branch at our GitHub Pages or you can opt to build it locally using the doc_doxygen target in the Makefile.

Before commiting it's recommended to run make with format target as we care about the project remaining clean!

To get rid of output files we provide the clean-vtk target with make. Happy simulations!