Repository files navigation

A python package to perform symmetry detection and generator extraction onraw data. Follows the paper by Sven Krippendorf and Marc Syvaeri onDetecting symmetries with neural networks.

This project is under heavy development and is therefore not available on PyPi.I would not expect major API breaks but certainly addition of functionality.

There are several options for installing SymDet

We host the code on PyPi and so it can be simply installed by:

pip3 install symdet

pip installation

git clone https://github.com/zincware/SymSuite.gitcd SymDetpip3 install. --user

conda installation

git clone https://github.com/zincware/SymSuite.gitcd SymDetconda create -n SymDet python=3.8conda activate SymDetpip3 install.

There is a live version of the documentation hostedhere. Alternatively you canbuild it from source using

cd Symdet/docsmake html

You can then browse the documentation locally using your favourite browser.

As a first step I would suggest looking at theexamplesdirectory and following along with some tutorials.From here you may get a better idea of what you can use this package for.

This is a really young project and any comments or contributions would bewelcome. If you see issues in the documentation (particularly if you're amathematician) I would always welcome the feedback.