Skip to main content

Symmetry detection and Lie generator extraction.

Project description

|build| |docs| |madewithpython| |license|

SymDet

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 <https://iopscience.iop.org/article/10.1088/2632-2153/abbd2d>_.

Notes

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.

Installation

Currently it is only possible to install SymDet from source and it will remain like this until it has been thoroughly tested on experimental data and a larger number of symmetry groups.

Install from source


pip installation

.. code-block:: bash

git clone https://github.com/SamTov/SymDet.git cd SymDet pip3 install . --user

conda installation

.. code-block:: bash

git clone https://github.com/SamTov/SymDet.git cd SymDet conda create -n SymDet python=3.8 conda activate SymDet pip3 install .

Documentation


There is a live version of the documentation hosted here <https://symdet.readthedocs.io/en/latest/>_. Alternatively you can build it from source using

.. code-block:: bash

cd Symdet/docs make html

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

Getting started

Because SymDet is not designed for single purpose, you will need to interface with different libraries and classes directly. This isn't as bad as it sounds and we have a number of tutorials to explain how this works. Broadly there are two modules relevant to most analysis, these are the analysis and generators modules.

  • analysis: This module contains the necessary methods for analyzing raw data and extraction symmetry groups from it.
  • generators: This module contains all of the modules necessary for extracting Lie group generators from the symmetry groups.

As a first step I would suggest looking at the examples <https://github.com/SamTov/SymDet/tree/main/examples>_ directory and following along with some tutorials.

Comments

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.

.. badges

.. |build| image:: https://github.com/SamTov/SymDet/actions/workflows/python-package.yml/badge.svg :alt: Build tests passing :target: https://github.com/SamTov/SymDet/blob/readme_badges/

.. |docs| image:: https://readthedocs.org/projects/symdet/badge/?version=latest&style=flat :alt: Build tests passing :target: https://symdet.readthedocs.io/en/latest/

.. |license| image:: https://img.shields.io/badge/License-EPLv2.0-purple.svg?style=flat :alt: Project license :target: https://www.gnu.org/licenses/quick-guide-gplv3.en.html

.. |madewithpython| image:: https://img.shields.io/badge/Made%20With-Python-blue.svg :alt: Made with python

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

SymDet-0.0.1.tar.gz (20.8 kB view details)

Uploaded Source

Built Distribution

SymDet-0.0.1-py3-none-any.whl (29.4 kB view details)

Uploaded Python 3

File details

Details for the file SymDet-0.0.1.tar.gz.

File metadata

  • Download URL: SymDet-0.0.1.tar.gz
  • Upload date:
  • Size: 20.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.10

File hashes

Hashes for SymDet-0.0.1.tar.gz
Algorithm Hash digest
SHA256 f1ce3357fb9d7d911039711b0088d9605e8ee304fccd3804ecfbe5624aeef619
MD5 b2044778a96bfebdc56efd6efc5ea44d
BLAKE2b-256 4931bc7cf0edcebdbcf4c23ae2de4afa8e2f4fb3bccb83597bd32b84b7731928

See more details on using hashes here.

File details

Details for the file SymDet-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: SymDet-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 29.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.10

File hashes

Hashes for SymDet-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e7131b9837054fad7d067a25730f5817858a9a4390951e5dd4ff179c2375f9bc
MD5 6ba3ef772fe733c84835bb7aceccc533
BLAKE2b-256 09e6161bb55a60abb72e3a69f357908a61937a17e5238b8e74853189b0bdf381

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page