A python package to perform symmetry detection and generator extraction on raw data. Follows the paper by Sven Krippendorf and Marc Syvaeri on Detecting 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 symdetpip installation
git clone https://github.com/zincware/SymSuite.git
cd SymDet
pip3 install . --userconda installation
git clone https://github.com/zincware/SymSuite.git
cd SymDet
conda create -n SymDet python=3.8
conda activate SymDet
pip3 install .There is a live version of the documentation hosted here. Alternatively you can build it from source using
cd Symdet/docs
make htmlYou can then browse the documentation locally using your favourite browser.
As a first step I would suggest looking at the examples directory 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 be welcome. If you see issues in the documentation (particularly if you're a mathematician) I would always welcome the feedback.