snappy 3.3__cp310-cp310-manylinux_2_24_aarch64.manylinux_2_28_aarch64.whl

snappy/test.py

@@ -0,0 +1,213 @@
+import os
+import sys
+import glob
+import argparse
+import snappy
+import snappy.snap.test
+import spherogram.test
+import snappy.matrix
+import snappy.verify.test
+import snappy.geometric_structure.test
+import snappy.ptolemy.test
+import snappy.tiling.test
+import snappy.cusps.test
+import snappy.raytracing.test
+import snappy.len_spec.test
+import snappy.margulis.test
+import snappy.drilling.test
+import snappy.canonical
+import snappy.cusps.cusp_area_matrix
+import snappy.cusps.cusp_areas_from_matrix
+import snappy.isometry_signature
+import snappy.exterior_to_link.test
+import snappy.pari
+import snappy.test_cases
+import snappy.numeric_output_checker
+import snappy.cusps
+
+from snappy.sage_helper import _within_sage
+from snappy.testing import (doctest_modules, cyopengl_works,
+                            tk_root, root_is_fake, DocTestParser)
+
+# Augment tests for SnapPy with those that Cython missed
+
+missed_classes = ['Triangulation', 'Manifold',
+                  'AbelianGroup', 'FundamentalGroup', 'HolonomyGroup',
+                  'DirichletDomain', 'CuspNeighborhood', 'SymmetryGroup',
+                  'AlternatingKnotExteriors', 'NonalternatingKnotExteriors']
+
+for A in missed_classes:
+    snappy.SnapPy.__test__[A + '_extra'] = getattr(snappy, A).__doc__
+    snappy.SnapPyHP.__test__[A + '_extra'] = getattr(snappy, A).__doc__
+
+# some things we don't want to test at the extension module level
+identify_tests = [x for x in snappy.SnapPyHP.__test__
+                  if x.startswith('Manifold.identify')]
+triangulation_tests = [x for x in snappy.SnapPyHP.__test__
+                  if x.startswith('get_triangulation_tester')]
+browser_tests = [x for x in snappy.SnapPyHP.__test__
+                 if x.startswith('Manifold.browse')]
+for key in identify_tests + triangulation_tests + browser_tests:
+    snappy.SnapPyHP.__test__.pop(key)
+
+def additional_doctests(verbose=False, print_info=True):
+    """
+    I noticed that some of my changes to move code from here into
+    its own files caused some loss of test coverage.
+
+    In a panic, adding them explicitly here.
+
+    There ought to be a better way to do this...
+    """
+
+    globs = {'Manifold' : snappy.Manifold,
+             'ManifoldHP' : snappy.ManifoldHP}
+    return doctest_modules(
+        [ snappy.isometry_signature,
+          snappy.canonical,
+          snappy.cusps.cusp_area_matrix,
+          snappy.cusps.cusp_areas_from_matrix
+         ],
+        verbose=verbose,
+        print_info=print_info,
+        extraglobs = globs)
+additional_doctests.__name__ = 'snappy.<HARD TO REACH>'
+
+modules = [
+    snappy.exterior_to_link.test.run_doctests,
+    snappy.numeric_output_checker.run_doctests,
+    snappy.number,
+    snappy.SnapPy,
+    snappy.SnapPyHP,
+    snappy.database,
+    additional_doctests,
+    snappy,
+    snappy.cusps.test.run_doctests,
+    snappy.snap.test.run_doctests,
+    snappy.matrix,
+    snappy.geometric_structure.test.run_doctests,
+    snappy.tiling.test.run_doctests,
+    snappy.cusps.test.run_doctests,
+    snappy.raytracing.test.run_doctests,
+    snappy.len_spec.test.run_doctests,
+    snappy.margulis.test.run_doctests,
+    snappy.drilling.test.run_doctests,
+    snappy.ptolemy.test.run_doctests,
+    spherogram.test.run_doctests,
+    snappy.verify.test.run_doctests,
+    snappy.test_cases
+]
+
+slow_modules = [
+    snappy.ptolemy.test.run_ptolemy_tests
+]
+
+def graphics_failures(verbose, windows, use_modernopengl):
+    if cyopengl_works():
+        print("Testing graphics ...")
+        import snappy.CyOpenGL
+        result = doctest_modules([snappy.CyOpenGL], verbose=verbose).failed
+        snappy.Manifold('m004').dirichlet_domain().view().test()
+        snappy.Manifold('m125').cusp_neighborhood().view().test()
+        if use_modernopengl:
+            snappy.Manifold('m004').inside_view().test()
+        snappy.Manifold('4_1').browse().test(use_modernopengl=use_modernopengl)
+        snappy.ManifoldHP('m004').dirichlet_domain().view().test()
+        snappy.ManifoldHP('m125').cusp_neighborhood().view().test()
+        if use_modernopengl:
+            snappy.ManifoldHP('m004').inside_view().test()
+        if root_is_fake():
+            root = tk_root()
+            if root:
+                if windows:
+                    print('Close the root window to finish.')
+                else:
+                    print('The windows will close in a few seconds.\n'
+                          'Specify -w or --windows to avoid this.')
+                    root.after(7000, root.destroy)
+                root.mainloop()
+    else:
+        print("***Warning***: Could not test CyOpenGL.")
+        try:
+            import snappy.CyOpenGL
+            print("Reason: Unsuitable Tk configuration for CyOpenGL")
+        except ImportError as e:
+            print("Reason: CyOpenGL could not be imported, %r" % e)
+        result = 0
+    return result
+
+
+def check_for_docs():
+    path = os.path.dirname(snappy.__file__)
+    match = os.path.join(path, 'doc', '*.html')
+    html_files = [os.path.basename(file) for file in glob.glob(match)]
+    if len(html_files) > 20 and 'index.html' in html_files:
+        print('HTML docs are included.')
+    else:
+        print('WARNING: HTML docs are missing!')
+
+
+def runtests(verbose=False,
+             quick=False,
+             windows=False,
+             use_modernopengl=True,
+             graphics=True):
+
+    # The default PARI stacksize can (slightly) overflow, causing
+    # doctests to fail.
+    snappy.pari.allocatemem(2**24, 2**25, silent=True)
+
+    DocTestParser.use_cymodernopengl = use_modernopengl
+
+    all_modules = modules
+    if not quick:
+        all_modules += slow_modules
+
+    result = doctest_modules(
+        all_modules, verbose=verbose, print_info=True)
+
+    if not quick:
+        print()
+        spherogram.links.test.run()
+    print('\nAll doctests:\n   %s failures out of %s tests.' % result)
+
+    if graphics:
+        num_graphics_failures = graphics_failures(
+            verbose=verbose,
+            windows=windows,
+            use_modernopengl=use_modernopengl)
+    else:
+        num_graphics_failures = 0
+
+    print('Pari stacksize', snappy.pari.stacksize(),
+          'max stack size', snappy.pari.stacksizemax())
+
+    check_for_docs()
+    return result.failed + num_graphics_failures
+
+
+if __name__ == '__main__':
+    verbose = False
+    quick = False
+    windows = False
+    use_modernopengl = True
+    graphics = True
+
+    useful_args = [arg for arg in sys.argv[1:] if not arg.startswith('-psn_')]
+
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-v', '--verbose', action='store_true',
+                        help='show additional information')
+    parser.add_argument('-q', '--quick', action='store_true',
+                        help='skip ptolemy and spherogram.links tests.')
+    parser.add_argument('-w', '--windows', action='store_true',
+                        help='keep windows open until user closes root window.')
+    parser.add_argument('-s', '--skip-modern-opengl', action='store_false',
+                        dest='use_modernopengl',
+                        help='skip tests requiring OpenGL 3.2 or later.')
+    parser.add_argument('-g', '--skip-gui', action='store_false',
+                        dest='graphics',
+                        help='skip tests bringing up GUI windows.')
+    args = parser.parse_args(useful_args)
+
+    sys.exit(runtests(**vars(args)))

snappy/test_cases.py

@@ -0,0 +1,263 @@
+"""
+IMPORTANT: Python only recognises this as a doc string if there is
+nothing before it. In particular, add any includes after the doc string.
+
+Doc tests that we do not want to show up in the documentation.
+
+Decorated isomorphism signature
+-------------------------------
+
+An example where the isosig doesn't pick up the identity perm
+because the lexicographic order of the perm interacts with the
+matrices.
+
+>>> T = Triangulation("L6n1(0,0)(0,0)(0,0)")
+>>> T.triangulation_isosig()
+'gLMzQbcdefffaelaaai_acbBaabCbbabbBC'
+
+Test that slopes are computed correctly.
+
+>>> M=Manifold("L14n63023(-5,1)(5,1)(10,1)")
+>>> M.triangulation_isosig(decorated=False, ignore_orientation=False)
+'vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt'
+
+The canonical orientation (used to compute the unoriented isosig)
+is the reverse of the actual orientation:
+
+>>> M.triangulation_isosig(decorated=False)
+'vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth'
+>>> Mop = M.copy()
+>>> Mop.reverse_orientation()
+>>> Mop.triangulation_isosig(decorated=False, ignore_orientation=False)
+'vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth'
+
+So we expect the oriented isometry signature to flip when neither the isomorphism
+signature nor its decoration capture the orientation.
+
+The following is a baked version of snappy.decorated_isosig.test_slope_transformations().
+The 32 calls to ManifoldHP.isometry_signature are just too expensive for the test suite.
+
+>>> for ignore_cusp_ordering in [False, True]:
+...     for ignore_curves in [False, True]:
+...         for ignore_curve_orientations in [False, True]:
+...             for ignore_filling_orientations in [False, True]:
+...                 for ignore_orientation in [False, True]:
+...                     isosig = M.triangulation_isosig(
+...                         ignore_cusp_ordering = ignore_cusp_ordering,
+...                         ignore_curves = ignore_curves,
+...                         ignore_curve_orientations = ignore_curve_orientations,
+...                         ignore_filling_orientations = ignore_filling_orientations,
+...                         ignore_orientation = ignore_orientation)
+...                     print(isosig)
+vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt_dcbaabBBBbBaBbCbBbCb(-5,1)(5,1)(10,1)(0,0)
+vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth_cabdBacbbBCbaBBBbabB(-5,1)(5,1)(10,1)(0,0)
+vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt_dcbaabBBBbBaBbCbBbCb(-5,1)(5,1)(10,1)(0,0)
+vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth_cabdBacbbBCbaBBBbabB(-5,1)(5,1)(10,1)(0,0)
+vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt_dcbaabBBbBbabBcBbBcB(-5,1)(-5,-1)(-10,-1)(0,0)
+vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth_cabdbacbbBcBabBBbaBb(5,1)(5,-1)(-10,1)(0,0)
+vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt_dcbaabBBbBbabBcBbBcB(-5,1)(5,1)(10,1)(0,0)
+vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth_cabdbacbbBcBabBBbaBb(5,1)(-5,1)(-10,1)(0,0)
+vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt_dcba(-1,-6)(-6,5)(-12,11)(0,0)
+vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth_cabd(-7,-1)(-3,4)(1,11)(0,0)
+vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt_dcba(1,6)(-6,5)(-12,11)(0,0)
+vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth_cabd(7,1)(-3,4)(1,11)(0,0)
+vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt_dcba(-1,-6)(-6,5)(-12,11)(0,0)
+vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth_cabd(-7,-1)(-3,4)(1,11)(0,0)
+vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt_dcba(1,6)(-6,5)(-12,11)(0,0)
+vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth_cabd(7,1)(-3,4)(1,11)(0,0)
+vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt_BbCbBbCbBbBaabBB(0,0)(10,1)(5,1)(-5,1)
+vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth_aBBBBacbbBCbbabB(10,1)(-5,1)(5,1)(0,0)
+vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt_BbCbBbCbBbBaabBB(0,0)(10,1)(5,1)(-5,1)
+vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth_aBBBBacbbBCbbabB(10,1)(-5,1)(5,1)(0,0)
+vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt_bBcBbBcBbBbaabBB(0,0)(-10,-1)(-5,-1)(-5,1)
+vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth_abBBbacbbBcBbaBb(-10,1)(5,1)(5,-1)(0,0)
+vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt_bBcBbBcBbBbaabBB(0,0)(10,1)(5,1)(-5,1)
+vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth_abBBbacbbBcBbaBb(-10,1)(5,1)(-5,1)(0,0)
+vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt(0,0)(-12,11)(-6,5)(6,-1)
+vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth(1,11)(-7,-1)(-3,4)(0,0)
+vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt(0,0)(-12,11)(-6,5)(-6,1)
+vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth(1,11)(7,1)(-3,4)(0,0)
+vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt(0,0)(-12,11)(-6,5)(6,-1)
+vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth(1,11)(-7,-1)(-3,4)(0,0)
+vLLvvLLMALQQzQQceillmnppqrlmrqtruututiivimllaelaqxrvdoxqltt(0,0)(-12,11)(-6,5)(-6,1)
+vLLvLLPwPQLAMPQcefikkmnplkopqrsttutuuiixvimqlippawidlabavth(1,11)(7,1)(-3,4)(0,0)
+
+The special case where we do not encode the matrices and have the identity perm
+and need it:
+
+>>> T = Triangulation('ovLMvvPQQQccddlmnijklmnmnlgvfamtvfblhaumx_BBbacBbacBbaBCaB(312,241)(332,441)(3322,1441)(726,541)')
+>>> T.homology()
+Z/4684873938228
+>>> isosig = T.triangulation_isosig(ignore_curves=True, ignore_cusp_ordering=False)
+>>> isosig
+'ovLMvvPQQQccddlmnijklmnmnlgvfamtvfblhaumx_abcd(71,312)(-1105,332)(-8085,3322)(726,1993)'
+>>> Triangulation(isosig).homology()
+Z/4684873938228
+
+
+isometry_signature
+------------------
+
+>>> M = Manifold('m004(1,2)')
+>>> M.isometry_signature()
+'cPcbbbiht(3,2)'
+
+sage: M.isometry_signature(verified=True)
+'cPcbbbiht(3,2)'
+
+>>> M = ManifoldHP('m004(1,2)')
+>>> M.isometry_signature()
+'cPcbbbiht(3,2)'
+
+sage: M.isometry_signature(verified=True) # Test bug reported by Nathan
+'cPcbbbiht(3,2)'
+
+# Cases where the drilled manifold had a canonical cell decomposition
+# with non-tetrahedral cells.
+
+>>> M = Manifold('m137(3,2)')
+>>> M.isometry_signature()
+'sLLvwzvQPAQPQccghmiljkpmqnoorqrrqfafaoaqoofaoooqqaf(3,2)'
+
+sage: M.isometry_signature(verified=True)
+'sLLvwzvQPAQPQccghmiljkpmqnoorqrrqfafaoaqoofaoooqqaf(3,2)'
+
+>>> M = ManifoldHP('m137(3,2)')
+>>> M.isometry_signature()
+'sLLvwzvQPAQPQccghmiljkpmqnoorqrrqfafaoaqoofaoooqqaf(3,2)'
+
+sage: M.isometry_signature(verified=True)
+'sLLvwzvQPAQPQccghmiljkpmqnoorqrrqfafaoaqoofaoooqqaf(3,2)'
+
+sage: M.isometry_signature(verified=True, exact_bits_prec_and_degrees=[]) # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
+Traceback (most recent call last):
+...
+RuntimeError: Could not compute or verify canonical retriangulation of drilled manifold. Geodesic was: abCDaDAd.
+
+Test isometry_signature's ignore_orientation
+
+>>> M = Manifold("m006")
+>>> M.isometry_signature(ignore_orientation=False)
+'eLMkaccddjgbaj'
+>>> M.isometry_signature(ignore_orientation=True)
+'eLAkaccddngbak'
+>>> M.isometry_signature() # default value
+'eLAkaccddngbak'
+>>> M.dehn_fill((3,4))
+>>> M.isometry_signature(ignore_orientation=False)
+'eLMkaccddjgbaj(-1,4)'
+>>> M.isometry_signature(ignore_orientation=True)
+'eLAkaccddngbak(-3,4)'
+
+Test isometry_signature's of_link and filling.
+
+>>> Manifold("o9_44206(2,3)").isometry_signature(of_link=True)
+'jLLvMQQacggfiihhijkkjkehhtb_abBabBbabaab'
+
+Class hierarchy
+---------------
+
+>>> isinstance(Manifold("m004"), Triangulation)
+True
+
+>>> isinstance(ManifoldHP("m004"), TriangulationHP)
+True
+
+Low precision and high precision comparisons
+--------------------------------------------
+>>> M   = Manifold("m004")
+>>> Mhp = Manifold("m004")
+>>> N   = Manifold("m003")
+>>> Nhp = Manifold("m003")
+>>> M.is_isometric_to(M)
+True
+>>> M.is_isometric_to(Mhp)
+True
+>>> Mhp.is_isometric_to(M)
+True
+>>> Mhp.is_isometric_to(Mhp)
+True
+>>> M.is_isometric_to(N)
+False
+>>> M.is_isometric_to(Nhp)
+False
+>>> Mhp.is_isometric_to(N)
+False
+>>> Mhp.is_isometric_to(Nhp)
+False
+
+>>> O = Triangulation("mvvLALQQQhfghjjlilkjklaaaaaffffffff",
+... remove_finite_vertices = False)
+>>> O.has_finite_vertices()
+True
+>>> Ohp = TriangulationHP("mvvLALQQQhfghjjlilkjklaaaaaffffffff",
+... remove_finite_vertices = False)
+>>> Ohp.has_finite_vertices()
+True
+
+>>> len(O.isomorphisms_to(O))
+8
+>>> len(O.isomorphisms_to(Ohp))
+8
+>>> len(Ohp.isomorphisms_to(O))
+8
+>>> len(Ohp.isomorphisms_to(Ohp))
+8
+>>> len(M.isomorphisms_to(O))
+0
+>>> len(M.isomorphisms_to(Ohp))
+0
+>>> len(Mhp.isomorphisms_to(O))
+0
+>>> len(Mhp.isomorphisms_to(Ohp))
+0
+
+Canonical retriangulation
+-------------------------
+
+Some cases that should be rejected
+
+>>> M = Manifold("m004(3,4)")
+>>> M.canonical_retriangulation() # doctest: +ELLIPSIS
+Traceback (most recent call last):
+...
+ValueError: Canonical retriangulation needs all cusps to be complete.
+
+sage: M.canonical_retriangulation(verified=True) # doctest: +ELLIPSIS
+Traceback (most recent call last):
+...
+ValueError: Canonical retriangulation needs all cusps to be complete.
+
+Cusp areas
+----------
+
+>>> M = Manifold('o9_44210')
+>>> M.cusp_areas(policy='greedy') # doctest: +NUMERIC9
+[7.053940530873898, 3.2712450270, 2.7091590087]
+>>> M.cusp_areas(policy='greedy', first_cusps=[]) # doctest: +NUMERIC9
+[7.053940530873898, 3.2712450270, 2.7091590087]
+>>> M.cusp_areas(policy='greedy', first_cusps=[0,]) # doctest: +NUMERIC9
+[7.053940530873898, 3.2712450270, 2.7091590087]
+>>> M.cusp_areas(policy='greedy', first_cusps=[0,1]) # doctest: +NUMERIC9
+[7.053940530873898, 3.2712450270, 2.7091590087]
+>>> M.cusp_areas(policy='greedy', first_cusps=[0,1,2]) # doctest: +NUMERIC9
+[7.053940530873898, 3.2712450270, 2.7091590087]
+>>> M.cusp_areas(policy='greedy', first_cusps=[0,2,1]) # doctest: +NUMERIC9
+[7.053940530873898, 2.3513135103, 3.7690945490]
+>>> M.cusp_areas(policy='greedy', first_cusps=[1,]) # doctest: +NUMERIC9
+[2.30025338030798, 10.0315765558665, 0.883442685721903]
+
+Cusp translations
+-----------------
+
+>>> M = Manifold("s776")
+>>> M.cusp_translations(policy = 'greedy', first_cusps = [], bits_prec = 100) # doctest: +NUMERIC21
+[(0.70710678118654752440084436210 + 1.8708286933869706927918743662*I, 2.8284271247461900976033774484), (0.35355339059327376220042218105 + 0.93541434669348534639593718308*I, 1.4142135623730950488016887242), (0.35355339059327376220042218105 + 0.93541434669348534639593718308*I, 1.4142135623730950488016887242)]
+
+
+"""
+
+if not __doc__:
+    raise Exception("doc string with tests was not recognized.")
+
+from . import Manifold, ManifoldHP, Triangulation, TriangulationHP

snappy/testing.py

@@ -0,0 +1,131 @@
+from .numeric_output_checker import NumericOutputChecker
+from .sage_helper import _within_sage
+
+import doctest
+import getopt
+import re
+import sys
+import types
+
+# Used for doctesting
+_gui_status = {}
+
+try:
+    from snappy.gui import Tk_
+    _gui_status['tk'] = True
+except ImportError:
+    _gui_status['tk'] = False
+if _gui_status['tk']:
+    try:
+        import snappy.CyOpenGL
+        _gui_status['cyopengl'] = True
+    except:
+        _gui_status['cyopengl'] = False
+else:
+    _gui_status['cyopengl'] = False
+_gui_status['fake_root'] = False
+
+def cyopengl_works():
+    if not _gui_status['cyopengl']:
+        return False
+    # if we are running the tests from the snappy app the default root will
+    # already exist -- it will be the tkterminal window.  Otherwise, we open
+    # a root window here to serve as the master of all of the GUI windows
+    # which get created during testing.
+    if _gui_status['tk'] and not Tk_._default_root:
+        try:
+            root = Tk_.Tk()
+            if sys.platform not in ('linux', 'linux2'):
+                root.withdraw()
+        except:
+            # tkinter loads OK but is not able to get a display.
+            _gui_status['tk'] = _gui_status['cyopengl'] = False
+    return _gui_status['cyopengl']
+
+
+def tk_root():
+    if _gui_status['tk']:
+        return Tk_._default_root
+    else:
+        return None
+
+def root_is_fake():
+    return _gui_status['fake_root']
+
+class DocTestParser(doctest.DocTestParser):
+    use_cyopengl = False
+    use_cymodernopengl = True
+    use_sage = _within_sage
+
+    def parse(self, string, name='<string>'):
+        string = re.subn(
+            r'#doctest: \+CYOPENGL',
+            '' if DocTestParser.use_cyopengl else '#doctest: +SKIP',
+            string)[0]
+
+        string = re.subn(
+            r'#doctest: \+CYMODERNOPENGL',
+            (''
+             if (DocTestParser.use_cyopengl and
+                 DocTestParser.use_cymodernopengl)
+             else '#doctest: +SKIP'),
+            string)[0]
+
+        if DocTestParser.use_sage:
+            string = re.subn(r'(\n\s*)sage:|(\A\s*)sage:',
+                             r'\g<1>>>>',
+                             string)[0]
+        return doctest.DocTestParser.parse(self, string, name)
+
+if _within_sage:
+    try:
+        from sage.all import PSL, BraidGroup
+    except ImportError:
+        import sage.groups.perm_gps.permgroup_element
+        from sage.groups.perm_gps.permgroup_named import PSL
+        from sage.groups.braid import BraidGroup
+    globs = {'PSL': PSL, 'BraidGroup': BraidGroup}
+else:
+    globs = {}
+
+def print_results(module, results):
+    root = tk_root()
+    # Platform specific hacks to make running the tests work.
+    if root and not root_is_fake():
+        if sys.platform in ('linux', 'linux2'):
+            root.deiconify()
+            root.update_idletasks()
+        else:
+            root.update()
+    print(module.__name__ + ':')
+    print('   %s failures out of %s tests.' % (results.failed,
+                                               results.attempted))
+
+def doctest_modules(modules, verbose=False, print_info=False, extraglobs={}):
+    finder = doctest.DocTestFinder(parser=DocTestParser())
+    full_extraglobals = globs.copy()
+    full_extraglobals.update(extraglobs)
+    failed, attempted = 0, 0
+    for module in modules:
+        if isinstance(module, types.ModuleType):
+            runner = doctest.DocTestRunner(checker=NumericOutputChecker(), verbose=verbose)
+            for test in finder.find(module, extraglobs=full_extraglobals):
+                runner.run(test)
+            result = runner.summarize()
+        else:
+            result = module(verbose=verbose, print_info=False)
+        failed += result.failed
+        attempted += result.attempted
+        if print_info:
+            print_results(module, result)
+
+    if print_info:
+        print('\nAll doctests:\n   %s failures out of %s tests.' % (failed, attempted))
+    return doctest.TestResults(failed, attempted)
+
+def run_doctests_as_main(run_doctests):
+    optlist, args = getopt.getopt(sys.argv[1:], 'v', ['verbose'])
+    verbose = len(optlist) > 0
+    results = run_doctests(verbose=verbose, print_info=True)
+    sys.exit(results.failed)
+

snappy/tiling/__init__.py

@@ -0,0 +1,2 @@
+# Tiling H^3 or quotients of H^3
+

snappy/tiling/dict_based_set.py

@@ -0,0 +1,79 @@
+class DictBasedSet:
+    """
+    This class can be constructed from a dictionary with keys in A.
+
+    The resulting object is a set of A.
+
+    >>> fruit_set = DictBasedSet(dict())
+    >>> fruit_set.add('Apple')
+    True
+    >>> fruit_set.add('Banana')
+    True
+    >>> fruit_set.add('Apple') # Already added earlier
+    False
+
+    """
+
+    def __init__(self, dictionary):
+        self._dictionary = dictionary
+
+    def add(self, key) -> bool:
+        """
+        Adds key to set of A.
+
+        Returns true if key was not yet in the set.
+        """
+        visited = self._dictionary.setdefault(key, [False])
+        if visited[0]:
+            return False
+        visited[0] = True
+        return True
+
+class DictBasedProductSet:
+    """
+    This class can be constructed from a dictionary with keys in A.
+
+    The resulting object is a set of AxB.
+
+    Can be combined with RealHashDict or QuotientDict.
+
+    >>> fruit_number_set = DictBasedProductSet(dict())
+    >>> fruit_number_set.add('Apple', 1)
+    True
+    >>> fruit_number_set.add('Banana', 1)
+    True
+    >>> fruit_number_set.add('Apple', 2)
+    True
+    >>> fruit_number_set.add('Apple', 1) # Already added earlier
+    False
+
+    """
+
+    def __init__(self, dictionary):
+        self._dictionary = dictionary
+
+    def add(self, key, element) -> bool:
+        """
+        Adds (key, element) in AxB to set.
+
+        Returns true if (key, element) was not yet in the set.
+        """
+        
+        elements = self._get_elements_for_key(key)
+        if element in elements:
+            return False
+        else:
+            elements.add(element)
+            return True
+
+    def _get_elements_for_key(self, key):
+        """
+        Could be used for potential future optimization:
+        When going to a neighboring tetrahedron paired through
+        a trivial face-pairing matrix (so it is a tetrahedron within
+        the same copy of the fundamental polyhedron), we can keep
+        a reference to the set returned by _get_elements_for_key
+        and just add the neighboring tetrahedron to this set rather
+        than doing the look-up from scratch.
+        """
+        return self._dictionary.setdefault(key, set())