README
This package constructs the elements and irreps of finite volume groups.
BASIC USAGE
To install the package in your python environment you can type 'pip install -e .'. Then the following line should run 'import FiniteVolumeGroups as fvg'.
An example of the basic usage of the library is given in examples/basic_usage.py
For more advanced usage see finitevolumegroups.readthedocs.io
TESTS
To run all the tests
coverage run -m pytest
coverage report -m
Running all of the tests takes about 10 minutes on my desktop, the longest test by far is testing the validity of all the irreps.
The tests include
- Checks group has correct number of elements
- Checks each conjugacy class has the correct number of elements
- Check the character table for the group (character of the irrep for each conjugacy class)
- Check that each irrep is actual a rep of the group, i.e. a. closed b. associative c. has identity d. has inverse