snappy 3.3__cp310-cp310-manylinux_2_24_aarch64.manylinux_2_28_aarch64.whl

snappy/doc/_sources/news.rst.txt

@@ -0,0 +1,425 @@
+.. SnapPy news
+
+====
+News
+====
+
+* Version 3.3 (January 2026):
+
+  - :class:`Link <spherogram.Link>` now supports band moves and can
+    search for ribbon disks and ribbon concordances. See
+    :meth:`ribbon_concordant_links
+    <spherogram.Link.ribbon_concordant_links>` and :meth:`add_band
+    <spherogram.Link.add_band>`.  From `[DG]
+    <https://arXiv.org/abs/2512.21825>`_.
+
+  - New census :class:`RibbonLinks <snappy.RibbonLinks>`.  From `[DG]
+    <https://arXiv.org/abs/2512.21825>`_.
+
+  - Additional slice obstructions added to
+    :meth:`slice_obstruction_HKL
+    <snappy.Triangulation.slice_obstruction_HKL>`.
+    From `[DG] <https://arXiv.org/abs/2512.21825>`_.
+
+  - The Fox-Milnor slice obstruction is now available as
+    :meth:`fox_milnor_test <snappy.Triangulation.fox_milnor_test>`.
+    From `[DG] <https://arXiv.org/abs/2512.21825>`_.
+
+  - The census :class:`OrientableCuspedCensus
+    <snappy.OrientableCuspedCensus>` has been extended to 10 ideal
+    tetrahedra by `[Li] <https://arXiv.org/abs/2512.02142>`_,
+    adding 150,000 new manifolds.
+	  
+  - Margulis number can now be computed with
+    :meth:`margulis <snappy.Manifold.margulis>`.
+
+  - The upper bounds on the bridge number of a link from `[BKVV2020]
+    <https://dx.doi.org/10.4310/CAG.2020.v28.n2.a2>`_ and `[BKP2025]
+    <https://arxiv.org/abs/2504.10517>`_ are available as
+    :meth:`bridge_upper_bound <spherogram.Link.bridge_upper_bound>`.
+
+  - :meth:`triangulation_isosig <snappy.Manifold.triangulation_isosig>` now
+    preserves the orientation of the core curve rather than the Dehn-filling
+    curve - thus, preserving the (unoriented) spun-triangulation structure.
+    This only changes the result when ``ignore_curves=True`` (and
+    ``ignore_orientation`` and ``ignore_filling_orientations`` have their
+    default values).
+
+  - Fixing a bug in
+    :meth:`length_spectrum_alt <snappy.Manifold.length_spectrum_alt>`
+    and
+    :meth:`length_spectrum_alt_gen <snappy.Manifold.length_spectrum_alt_gen>`.
+    The estimate for the upper bound of the global spine radius was not
+    correct in all cases. Note that we expect this bug to be very hard to hit
+    and do not have a single example where the result of these methods was
+    wrong.
+
+  - :meth:`length_spectrum_alt <snappy.Manifold.length_spectrum_alt>` can be
+    given ``count`` and ``max_len`` at the same time. In that case, it stops
+    when enough geodesics have been listed to ensure that they include the
+    ``count`` shortest geodesics or that they include all geodesics shorter
+    than ``max_len``.
+
+  - Acceleration to
+    :meth:`length_spectrum_alt <snappy.Manifold.length_spectrum_alt>` when
+    the next geodesic has large gap to the last geodesic in the result.
+    It uses the new ``include_intermediates=True`` flag of
+    :meth:`length_spectrum_alt_gen <snappy.Manifold.length_spectrum_alt_gen>`.
+
+  - Computing maximal cusp areas in an unbiased way uses a simpler algorithm
+    which also returns tighter intervals for verified computations.
+    This affects :meth:`cusp_areas <snappy.Manifold.cusp_areas>` and related
+    methods.
+
+  - Support for Python 3.14 and SageMath 10.8.
+    
+    
+
+* Version 3.2 (January 2025):
+
+  - An alternative implementation of the length spectrum. It supports verified
+    computations and is significantly faster in some cases. See
+    :meth:`length_spectrum_alt <snappy.Manifold.length_spectrum_alt>`
+    and
+    :meth:`length_spectrum_alt_gen <snappy.Manifold.length_spectrum_alt_gen>`.
+
+  - :meth:`isometry_signature <snappy.Manifold.isometry_signature>` now also
+    works for closed manifolds.
+
+  - A paper plane or eye ball in the
+    :meth:`inside_view <snappy.Manifold.inside_view>` showing the position
+    and bearing of the user in the hyperbolic manifold. By default, we now show
+    the paper plane instead of the edges of the triangulation so that the view
+    is intrinsic to the manifold. The geodesics window now also features a
+    button to put the camera onto a geodesic. Here are some examples:
+
+    .. list-table::
+       :width: 100%
+       :class: borderless
+
+       * - .. image:: images/o9_00000_systole_paper_plane.jpg
+              :width: 90%
+              :align: center
+              :alt: Paper plane near shortest geodesic of o9_00000
+         - .. image:: images/o9_00000_systole_paper_plane_closer.jpg
+              :width: 90%
+              :align: center
+              :alt: Paper plane very near shortest geodesic of o9_00000
+         - .. image:: images/m004_paper_plane_on_systole.jpg
+              :width: 90%
+              :align: center
+              :alt: Paper plane on shortest geodesic of m004
+         - .. image:: images/m125_paper_plane.jpg
+              :width: 90%
+              :align: center
+              :alt: Paper plane coming out of a cusp of m125
+
+  - A faster and more robust algorithm to the compute maximal cusp area matrix.
+    The new algorithm is now the default for
+    :meth:`~snappy.Manifold.cusp_area_matrix`,
+    :meth:`~snappy.Manifold.cusp_areas`,
+    :meth:`~snappy.Manifold.short_slopes` and
+    :meth:`~snappy.Manifold.cusp_translations`.
+
+  - New options ``ignore_curves`` and ``ignore_filling_orientations``
+    for :meth:`~snappy.Triangulation.triangulation_isosig`. Also
+    fixing a subtle bug where the filling coefficients returned by
+    :meth:`triangulation_isosig <snappy.Triangulation.triangulation_isosig>` were
+    not canonical when ``ignore_curve_orientations = True``.
+
+  - :meth:`~snappy.Manifold.canonical_retriangulation`
+    and
+    :meth:`~snappy.Manifold.isometry_signature` fail with
+    exceptions rather than silently returning ``None``. In particular, it now
+    safe to compare isometry signatures (without further checks) to determine
+    whether M and N are isometric hyperbolic manifolds::
+
+        >>> M.isometry_signature(verified=True) == N.isometry_signature(verified=True)
+
+  - Bug fix to :meth:`slice_obstruction_HKL
+    <snappy.Manifold.slice_obstruction_HKL>`: earlier versions
+    incorrectly allowed looking at mod 2 homology of the branched
+    cover, where the theory does not directly apply.
+
+  - New self-contained SnapPy application for Linux. 
+  
+  - Support for Python 3.13 and SageMath 10.5.
+
+
+* Versions 3.1 (May 2023) and 3.1.1 (June 2023):
+
+  - A method :meth:`exterior_to_link <snappy.Manifold.exterior_to_link>`
+    for going from a link exterior to a link diagram taken from
+    `Dunfield-Obeidin-Rudd <https://arxiv.org/abs/2112.03251>`_.
+
+  - Covers now computed by the stand-alone `low_index
+    <https://pypi.org/project/low-index/>`_ module, which uses
+    multiple processor cores and is typically much faster than the old
+    code.  In some cases, it is dramatically faster than even GAP or
+    Magma.
+
+  - Added geodesics to the :meth:`inside_view
+    <snappy.Manifold.inside_view>`.
+
+  - Added drilling any simple geodesic with :meth:`drill_word
+    <snappy.Manifold.drill_word>` and :meth:`drill_words
+    <snappy.Manifold.drill_words>`, not just those that are
+    :meth:`combinatorially simple <snappy.Manifold.dual_curves>`.
+
+  - Added `ignore_orientation` flag to :meth:`triangulation_isosig
+    <snappy.Triangulation.triangulation_isosig>`.
+
+  - Added `include_words` flag to :meth:`length_spectrum
+    <snappy.Manifold.length_spectrum>` for getting the word
+    corresponding to a geodesic which can be given to
+    :meth:`drill_word <snappy.Manifold.drill_word>`.
+
+  - Support for Python 3.11 and SageMath 10.0.
+
+  - Modernized styling of the documentation.
+
+* Version 3.0.3 (December 2021):
+
+  - Runs natively on Macs with Apple Silicon processors (M1, M2, and variants).
+
+* Version 3.0.2 (November 2021):
+
+  - Support for SageMath 9.4 and 9.5, Python 3.10, and macOS Monterey.
+
+* Version 3.0 (April 2021): New features include:
+
+  - Incorporates Zoltán Szabó's `program
+    <https://web.math.princeton.edu/~szabo/HFKcalc.html>`_ for
+    computing Knot Floer homology, see :meth:`knot_floer_homology
+    <spherogram.Link.knot_floer_homology>`.  This can compute the
+    Seifert genus of a 25 crossing knot in mere seconds!
+
+  - Topological slice obstructions of Herald-Kirk-Livingston, see
+    :meth:`slice_obstruction_HKL <snappy.Manifold.slice_obstruction_HKL>`.
+
+  - Faster "local" algorithm for :meth:`jones_polynomial
+    <spherogram.Link.jones_polynomial>`.
+
+  - `Cohomology fractals <https://arxiv.org/abs/2010.05840>`_ added to
+    :meth:`inside_view <snappy.Manifold.inside_view>`.
+
+  - Convention changes: Sign of knot signature (now positive knots have
+    negative signatures), choice of braid generators (now positive
+    generators give positive crossings).
+
+  - Updates to methods :meth:`cusp_translations
+    <snappy.Manifold.cusp_translations>`, :meth:`cusp_areas
+    <snappy.Manifold.cusp_areas>`, :meth:`short_slopes
+    <snappy.Manifold.short_slopes>`. Also :meth:`Link <spherogram.Link>`
+    now accepts DT codes.
+
+  - Support for SageMath 9.3, Python 3.9, and macOS Big Sur.
+
+  - macOS app now code-signed and notarized.
+
+  - SnapPy now requires Python 3.6 or newer.
+
+* Version 2.8 (June 2020): New features include:
+
+  - Raytraced interior views of a hyperbolic 3-manifold via the
+    :meth:`inside_view <snappy.Manifold.inside_view>` method, see also
+    `images <https://im.icerm.brown.edu/portfolio/snappy-views/>`_ and
+    `demo video <https://youtu.be/CAERhmUCkRs>`_.
+
+  - :doc:`verify`: Several new features:
+
+    * Complex volume (and thus the Chern-Simons invariant) for both
+      cusped and closed manifolds, see
+      :meth:`complex_volume <snappy.Manifold.complex_volume>`.
+
+    * Disjoint cusp neighborhoods by the method :meth:`cusp_areas
+      <snappy.Manifold.cusp_areas>` which uses
+      :meth:`cusp_area_matrix <snappy.Manifold.cusp_area_matrix>`.
+
+    * Cusp shapes (see :meth:`cusp_info <snappy.Manifold.cusp_info>`).
+
+    * Finding all :meth:`short_slopes <snappy.Manifold.short_slopes>`
+      in disjoint embedded cusp neighborhoods.
+
+  - The census :class:`HTLinkExteriors <snappy.HTLinkExteriors>` has
+    been extended to 15 crossing knots (contributed by Malik
+    Obeidin).
+
+  - The census :class:`CensusKnots <snappy.CensusKnots>` has been
+    extended to triangulations with 9 ideal tetrahedra.
+
+  - Support for SageMath 9.0 and macOS Catalina.
+
+  - Development moved to `GitHub <https://github.com/3-manifolds>`_.
+
+* Version 2.7 (July 2019): New features include:
+
+  - Python 3 is now recommended over Python 2 on all platforms; the
+    default Mac and Windows apps use Python 3 rather than
+    Python 2. The only difference most users will notice is that one
+    must type ``print(blah)`` instead of ``print blah``.
+
+  - `Verified computations <verify.html>`_: performance improvements
+    by switching to the Krawczyk test.
+
+  - Support for SageMath 8.8.
+
+  - Installation instructions extensively updated.
+
+  - GUI improvements, especially on macOS. These include improved
+    support for dark mode and tabs on macOS Mojave and preliminary
+    support for macOS Catalina.
+
+* Version 2.6.1 (August 2018): New features include:
+
+  - Support for SageMath 8.3, Python 3.7, and macOS Mojave.
+
+  - Computing `ideals defining SL(2, C) character varieties.
+    <additional_classes.html#snappy.HolonomyGroup.character_variety_vars_and_polys>`_
+    Contributed by Jean-Philippe Burelle, based on `this paper
+    <https://arxiv.org/abs/1703.08241>`_.
+
+  - Many bug fixes.
+
+* Version 2.6 (Nov 2017): New features include:
+
+  - Support for macOS High Sierra, SageMath 8.1, and Windows systems
+    using non-Latin alphabets.
+
+  - Many bug fixes, including improved Python 3 support.
+
+* Version 2.5 (Feb 2017): New features include:
+
+  - Rigorous computation of `hyperbolic volume
+    <manifold.html#snappy.Manifold.volume>`_.
+
+  - STL export of Dirichlet domains for 3D printing, contributed by
+    Jose Sanchez.
+
+  - Support for Python 3, SageMath 7.5, 7.6, and 8.0, and many more
+    versions of Python on Windows.
+
+  - Much improved infrastructure for testing and distributing SnapPy.
+
+* Version 2.4 (May 2016): New features include:
+
+  - Added `census of Platonic manifolds <platonic_census.html>`_.
+
+  - Rigorous computation of `cusp translations <manifold.html#snappy.Manifold.cusp_translations>`_.
+
+  - Added decorations to `triangulation isomorphism signatures
+    <manifold.html#snappy.Manifold.triangulation_isosig>`_ for
+    encoding peripheral curves.
+
+  - Faster verification of non-tetrahedral canonical cell decompositions.
+
+  - Improvements to the `link and planar diagram component
+    <spherogram.html>`_, mostly contributed by Malik Obeidin, include:
+
+    * Bar-Natan's super-fast `tangle-based algorithm
+      <http://www.math.toronto.edu/drorbn/Talks/Aarhus-1507/>`_ for
+      computing the Alexander polynomial.
+
+    * Can now compute the `Seifert matrix
+      <spherogram.html#spherogram.Link.seifert_matrix>`_ and express a
+      link as a `braid closure <spherogram.html#spherogram.Link.braid_word>`_.
+
+    * Conversion to/from `SageMath links and braids
+      <spherogram.html#spherogram.Link.sage_link>`_.
+
+    * Many under-the-hood improvements.
+
+  - New Windows installer.
+
+* Version 2.3 (March 2015):  New features include:
+
+  - Major improvements to the `link and planar diagram component
+    <spherogram.html>`_, including link simplification, random links,
+    and better documentation.
+
+  - Basic support for `spun normal surfaces
+    <manifold.html#snappy.Manifold.normal_boundary_slopes>`_.
+
+  - New extra features when used inside of Sage:
+
+    * HIKMOT-style `rigorous verification of hyperbolic structures
+      <verify.html>`_,
+      contributed by Matthias Goerner.
+
+    * Many `basic knot/link invariants
+      <spherogram.html#the-link-class>`_, contributed by Robert
+      Lipschitz and Jennet Dickinson.
+
+    * Sage-specific functions are now more easily accessible as
+      methods of Manifold and better documented.
+
+    * Improved number field recognition, thanks to Matthias.
+
+  - Better compatibility with OS X Yosemite and Windows 8.1.
+
+  - Development changes:
+
+    * Major source code reorganization/cleanup.
+
+    * Source code repository moved to `Bitbucket
+      <https://bitbucket.org/t3m>`_.
+
+    * Python modules now hosted on `PyPI
+      <https://pypi.python.org/pypi>`_, simplifying `installation <installing.html>`_.
+
+* Version 2.2 (June 2014): Includes Ben Burton's `census of
+  orientable cusped manifolds with 9 tetrahedra. <http://arxiv.org/abs/1405.2695>`_
+
+* Version 2.1 (February 2014): New `high-precision manifolds
+  (ManifoldHP) <manifoldhp.html>`_ which compute hyperbolic structures
+  (and everything related) in `quad-double (212 bit) <http://web.mit.edu/tabbott/Public/quaddouble-debian/qd-2.3.4-old/docs/qd.pdf>`_
+  precision.
+
+* Version 2.0 (September 2013): Many new features, including:
+
+  - A `manifold browser <manifold.html#snappy.Manifold.browse>`_
+    window for easily examining a particular manifold.
+
+  - Many improvements to the `link editor <plink.html#using-snappy-s-link-editor>`_, including
+
+    * A smoothed view mode with image export to EPS/PDF/SVG/TikZ.
+
+    * Producing a fully editable link from combinatorial data like a DT
+      code.
+
+  - `Splitting manifolds <manifold.html#snappy.Manifold.split>`_ along surfaces of non-negative euler
+    characteristic.
+
+  - Generalizing the ptolemy obstruction class to allow computation of
+    PGL(3,C)-representations and improving usability of the `ptolemy module
+    <http://www.unhyperbolic.org/ptolemy.html>`_.
+
+  - `CensusKnots <censuses.html#snappy.CensusKnots>`_ now includes
+    knot exteriors with 8 tetrahedra.
+
+* Version 1.8 (May 2013) improves handling of DT codes and adds the
+  `HTLinkExteriors <censuses.html#snappy.HTLinkExteriors>`_ census,
+  which provides identification for knots and links up to 14 crossings.
+
+* Version 1.7 (November 2012) incorporates the `ptolemy module
+  <http://www.unhyperbolic.org/ptolemy.html>`_ for studying
+  representations of 3-manifold groups into pSL(*N*, **C**).
+
+* Version 1.6 (August 2012) includes a `new way to make links
+  <spherogram.html>`_ and some support for `arbitrary precision calculation <snap.html>`_.
+
+* Version 1.5 (February 2012) includes `much improved manifold
+  censuses <censuses.html>`_.
+
+* Version 1.4 (December 2011) uses the current release of IPython, which has been completely rewritten.
+
+*  Version 1.3.10 (July 2011) incorporates `Twister
+   <https://github.com/MarkCBell/twister/>`_.
+
+* Version 1.3 (February 2011) has a completely redesigned cusp horoball viewer and many bug fixes!
+
+* Version 1.2 (December 2010).
+
+* Version 1.1 (February 2010).
+
+* Version 1.0 (August 2009) Initial version.

snappy/doc/_sources/other.rst.txt

@@ -0,0 +1,25 @@
+Other components
+===================
+
+SnapPy incorporates:
+
+Ptolemy module
+--------------
+
+The `ptolemy module <http://www.unhyperbolic.org/ptolemy.html>`_ for
+studying representations of 3-manifold groups into SL(*N*, **C**) and
+PSL(*N*, **C**).  By `Matthias Goerner
+<http://www.unhyperbolic.org/>`_.
+
+.. toctree::
+   :maxdepth: 3
+
+   ptolemy
+
+Twister
+-------
+
+`Twister <https://github.com/MarkCBell/twister>`_ for building
+surface bundles and Heegaard splittings from mapping class group
+data.  By Marc Bell, Tracy Hall, and Saul Schleimer.
+	

snappy/doc/_sources/platonic_census.rst.txt

@@ -0,0 +1,20 @@
+Censuses of Platonic manifolds
+==============================
+
+The following manifolds were tabulated in `A census of tetrahedral manifolds <http://arxiv.org/abs/1502.00383>`_ and `A census of Platonic manifolds and augmented knotted trivalent graphs <http://arxiv.org/abs/1602.02208v2>`_. An even larger census of Platonic manifolds can be downloaded `here <http://unhyperbolic.org/platonicCensus/large/platonicCensus_large_snappy_only.tar.bz2>`_.
+
+..   currentmodule:: snappy
+..   autodata:: TetrahedralOrientableCuspedCensus
+..   autodata:: TetrahedralNonorientableCuspedCensus
+..   autodata:: OctahedralOrientableCuspedCensus
+..   autodata:: OctahedralNonorientableCuspedCensus
+..   autodata:: CubicalOrientableCuspedCensus
+..   autodata:: CubicalNonorientableCuspedCensus
+..   autodata:: DodecahedralOrientableCuspedCensus
+..   autodata:: DodecahedralNonorientableCuspedCensus
+..   autodata:: IcosahedralOrientableClosedCensus
+..   autodata:: IcosahedralNonorientableClosedCensus
+..   autodata:: CubicalOrientableClosedCensus
+..   autodata:: CubicalNonorientableClosedCensus
+..   autodata:: DodecahedralOrientableClosedCensus
+..   autodata:: DodecahedralNonorientableClosedCensus

snappy/doc/_sources/plink.rst.txt

@@ -0,0 +1,102 @@
+.. Documentation of the plink part of SnapPy
+
+Using SnapPy's link editor
+=================================
+
+PLink draws piecewise linear link projections.  Components may be
+points, PL arcs, or PL circles.  Line segments are oriented consistently in
+each component.  Different components are different colors.
+
+..  image:: plink-action.png
+    :align: right
+
+To invoke the link editor, do::
+
+  In[5]:  M = Manifold()
+
+Once you've drawn the link, select the menu item "PLink->Tools->Send to
+SnapPy", and then *M* will be the complement of the link.  If you edit
+the link, you can again do "Send to SnapPy" to update *M*.  
+
+Drawing Basics
+------------------------------
+
+* When using the mouse to draw a link with PLink, you should always
+  *click-and-release*.  Do not hold the mouse button down while drawing.
+  PLink requires only the left mouse button.
+ 
+* The default state of the editor is indicated by the arrow cursor.
+  In this state, click-and-release the left mouse button on the
+  background to place a starting vertex and begin drawing.  The vertex
+  will be connected to the pencil cursor by a thin red line.
+  Click-and-release to place a second vertex.  The two vertices will
+  then be joined by an edge. Continue to draw other vertices and edges
+  to your heart's content.
+
+* To stop drawing, either click twice on the same vertex to create an
+  arc, or click on an endpoint vertex.  The latter operation will
+  either create a circle component or join together two arc
+  components.
+
+* When the cursor hovers over a vertex it changes to the pointing
+  finger.  From this state you can drag a vertex to a new location
+  with a click-and-release on the vertex. The vertex will become
+  enclosed in a circular cursor.  Move it to where you want it to go
+  and click the left (or middle) button to place it.  If you drag one
+  endpoint on top of another, they will meld.
+
+* When the cursor hovers over an edge, not too close to a vertex or
+  crossing, it changes to the push-me-pull-you cursor.  Clicking in
+  this state will change the orientation of the component containing
+  the edge.
+
+* When the cursor hovers over a crossing it changes to the yin-yang
+  recycling cursor.  Clicking while in this state changes the the
+  handedness of the crossing.
+
+* Double-clicking on an endpoint vertex will restart drawing from
+  that vertex.  Double-clicking on a non-endpoint vertex will break
+  the link at that point and begin drawing with the old incoming edge.
+
+* While in drawing state, hitting the Delete key removes the last
+  vertex before the cursor.  If no vertices remain, the drawing state
+  ends and the active component is removed.  This can be used to
+  remove a segment from the diagram.  Double-click a vertex; hit
+  Delete to remove the incoming segment at that vertex; then click the
+  vertex again to reconnect.
+
+* You will not be allowed to create edges that pass too close to a
+  vertex or a crossing, or to place vertices too close to edges or to
+  crossings or to other vertices.  If you attempt to do any of these
+  things, PLink will flash the drawing canvas.
+
+Miscellaneous Features
+---------------------------------
+
+The window can be resized to allow for different sizes of link
+projections, and the arrow keys can be used to slide the projection
+around in order to make more room on one side or another.
+
+The "Tools" menu can be used to make the projection alternating
+(provided that all components are circles), or to clear the screen,
+or to reflect the projection in the xy-plane, changing all crossings.
+Also, the "Tools" menu includes the "send to SnapPy" command.
+
+The "File" menu can be used to save the projection as a SnapPea
+link projection file.  (This can be done from the drawing state as
+well, in which case the "hot vertex" is remembered in the file!).  The
+"File->Open File" command will read a SnapPea link projection file,
+and restart drawing if the projection was saved while drawing.
+
+The "Info" menu selects information about the link projection to be
+displayed in the info line at the bottom.  Various encoding schemes
+for link projections are supported, as well as the blackboard framing
+curves, expressed in meridian-longitude coordinates.  Cutting and
+pasting from the info line is supported.  The numerical and
+alphabetical Dowker-Thistlethwaite codes are displayed in an extended
+form which includes a full description of the planar embedding.  The
+string printed in the info line is also accepted as input to SnapPy's
+Manifold constructor.  That is, you can paste the complete DT code,
+for example ``DT: [(-4,6,2)], [0,0,1]``, between the apostrophes in
+Manifold('').  The "DT labels" option displays the indexing used in
+computing the Dowker-Thistlethwaite codes.

snappy/doc/_sources/ptolemy.rst.txt

@@ -0,0 +1,66 @@
+The ptolemy module
+==================
+
+..   automodule:: snappy.ptolemy
+		  
+What is the ptolemy module?
+---------------------------
+
+This module provides tools to find boundary-unipotent representations of an
+oriented
+3-manifold into PSL(*N*, **C**). It was used, for example, to generate the tables
+of representations at
+`ptolemy.unhyperbolic.org <http://ptolemy.unhyperbolic.org/html/summary.html>`_.
+
+The ptolemy module can use `magma <http://magma.maths.usyd.edu.au/magma/>`_ for
+the computations necessary to find the representations or it can automatically
+retrieve the necessary computations from a database we provide that contains the
+computations for all manifolds and *N* at
+`ptolemy.unhyperbolic.org <http://ptolemy.unhyperbolic.org/html/summary.html>`_.
+In particular, the database includes the computations for all orientable census
+manifolds for PSL(2, **C**) and the examples below work without magma for these
+manifolds.
+This makes it useful for people who do not have magma (see :ref:`here <ptolemy-example-retrieve-exact-solutions>`).
+
+The ptolemy module is still under development. Please report bugs or email suggestions to: enischte at gmail dot com.
+
+Examples of what the Ptolemy module can do:
+
+* Give the :ref:`equations for the reduced Ptolemy varieties<ptolemy-example-basic>` to find all :ref:`generically decorated <ptolemy-generically-decorated>` and :ref:`boundary-unipotent <ptolemy-boundary-unipotent>` representations into SL(*N*, **C**).
+* Same for representations into PSL(*N*, **C**) using :ref:`Obstruction classes <ptolemy-example-obstruction-class>`.
+* Retrieve the :ref:`exact <ptolemy-example-retrieve-exact-solutions>` and :ref:`numerical <ptolemy-example-retrieve-numerical-solutions>` solutions for these varieties.
+* Compute the matrices for these representations :ref:`exactly <ptolemy-example-matrices>` or :ref:`numerically <ptolemy-example-numerical-matrix>` given a generator of or word in the fundamental group.
+* Compute the :ref:`traces <ptolemy-example-traces>` for these matrices.
+* Compute the :ref:`trace field <ptolemy-examples-trace-field>` of the representation.
+* Compute the :ref:`boundary holonomy <ptolemy-example-boundary-holonomy>`.
+* Compute the corresponding :ref:`shape parameters/cross ratios <ptolemy-example-cross-ratios>` for a representation.
+* Compute the :ref:`volume <ptolemy-example-volume>` and :ref:`complex volume <ptolemy-example-complex-volume>` (volume + i Chern-Simons) for a representation.
+* Compute solutions to the Ptolemy varieties :ref:`using magma or sage <ptolemy-example-using-magma-sage>`.
+* Find :ref:`positively dimensional components <ptolemy-non-zero-dim-comp>` of the Ptolemy variety.
+* Find :ref:`positively dimensional families <ptolemy-example-non-zero-dim-rep>` of boundary-unipotent representations.
+
+The ptolemy module tries to have powerful and flexible functionality but at the same time be easy to use. For example, we can get the volumes of boundary-unipotent PSL(2, **C**)-representations of ``m011`` in just one line::
+
+    >>> Manifold("m011").ptolemy_variety(2,'all').retrieve_solutions().volume_numerical()
+    [[[-4.30211422042248 E-16, -0.942707362776931, 0.942707362776931]],
+     [[4.64255370258293 E-15, 3.94215909915729 E-15, -2.78183391239608, 2.78183391239608]]]
+
+Here, we see that ``m011`` has a representation that is not Galois-conjugate to the geometric representation and that has the volume 0.9427... of the Weeks manifold.
+
+**Remark:** Please check your Internet connection if the above example does not work.
+
+Documentation
+-------------
+
+.. toctree::
+   :maxdepth: 2
+
+   ptolemy_prelim
+   ptolemy_examples1
+   ptolemy_examples2
+   ptolemy_examples3
+   ptolemy_examples4
+   ptolemy_classes
+
+
+

snappy/doc/_sources/ptolemy_classes.rst.txt

@@ -0,0 +1,42 @@
+Classes
+==============================
+
+PtolemyVariety
+--------------
+
+..   autoclass:: snappy.ptolemy.ptolemyVariety.PtolemyVariety
+     :members:
+
+PtolemyCoordinates
+------------------
+
+..   autoclass:: snappy.ptolemy.coordinates.PtolemyCoordinates
+     :members:
+
+CrossRatios
+-----------
+
+..   autoclass:: snappy.ptolemy.coordinates.CrossRatios
+     :members:
+
+Flattenings
+-----------
+
+..   autoclass:: snappy.ptolemy.coordinates.Flattenings
+     :members:
+
+NonZeroDimensionalComponent
+---------------------------
+
+..   autoclass:: snappy.ptolemy.component.NonZeroDimensionalComponent
+     :members:
+
+Other functions
+---------------
+
+..   autofunction:: snappy.ptolemy.solutions_from_magma
+
+..   autofunction:: snappy.ptolemy.solutions_from_magma_file
+
+
+.. [FKR2013] Falbel, Koseleff, Rouillier: Representations of Fundamental Groups of 3-Manifolds into PGL(3,C): Exact Computations in Low Complexity, http://arxiv.org/abs/1307.6697