.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "CENSUSLOOKUP" "1" "14 March 2023" "" "The Regina Handbook"

.SH NAME
censuslookup \- Search for triangulations in Regina's census databases
.SH SYNOPSIS

\fBcensuslookup\fR \fB\fIisosig\fB\fR\fI ...\fR


\fBcensuslookup\fR { \fB-v, --version\fR | \fB-?, --help\fR }

.SH "DESCRIPTION"
.PP
This utility searches for the given 3-manifold triangulations in the various
census databases that are shipped withRegina.
.PP
You should present the trianguations using their \fIisomorphism
signatures\fR\&.  These are short text strings that identify
the triangulation uniquely up to combinatorial isomorphism
(i.e., up to relabellings of the tetrahedra and/or their vertices).
.PP
From the graphical user interface, you can view the isomorphism signature
of a triangulation by switching to the Composition
tab in the triangulation viewer.  From Python you can fetch the
isomorphism signature of the triangulation \fBx\fR
by calling \fBx.isoSig()\fR\&.
For a full and precise specification of isomorphism signatures, see
\fBSimplification paths in the Pachner graphs of closed
orientable 3-manifold triangulations\fR, Burton, 2011,
arXiv:1110.6080.
.PP
All database matches (if any) will be written to standard output.
.SH "OPTIONS"
.TP
\fB-v, --version\fR
Show which version of Regina is being used, and exit
immediately.
.TP
\fB-?, --help\fR
Display brief usage information, and exit immediately.
.SH "ENVIRONMENT VARIABLES"
.PP
The following environment variables influence the behaviour of
this program.
.TP
\fB\fIREGINA_HOME\fB\fR
The directory beneath which Regina's data files are installed.
This utility will look for the census databases in the subdirectory
\fI$REGINA_HOME/data/census/\fR\&.

Normally you should not need to set this option yourself.
This utility should know how to find its census databases in standard
situations, which include
fixed filesystem installations (e.g., \fBGNU/Linux\fR and \fBWindows\fR),
relocatable app bundles (e.g., \fBmacOS\fR),
and running directly from the source tree.
.SH "EXAMPLE"

.nf
    example$ \fBcensuslookup fvPQcdecedekrsnrs dLQbcccajqs cPcbbbiht\fR
    fvPQcdecedekrsnrs: 1 hit
        SFS [S2: (2,1) (3,1) (5,-4)] : #1 -- Closed census (orientable)

    dLQbcccajqs: 0 hits

    cPcbbbiht: 2 hits
        m004 : #1 -- Cusped hyperbolic census (orientable)
        L104001 -- Hyperbolic knot and link complements

    example$
.fi
.SH "MACOS USERS"
.PP
If you downloaded a drag-and-drop app bundle, this utility is
shipped inside it.  If you dragged Regina to the main
Applications folder, you can run it as
/Applications/Regina.app/Contents/MacOS/censuslookup\&.
.SH "WINDOWS USERS"
.PP
The command-line utilities are installed beneath the
\fIProgram\~Files\fR directory; on some
machines this directory is called
\fIProgram\~Files\~(x86)\fR\&.
You can start this utility by running
c:\\Program\~Files\\Regina\\Regina\~7.3\\bin\\censuslookup.exe\&.
.SH "SEE ALSO"
.PP
regina-gui\&.
trisetcmp,
.SH "AUTHOR"
.PP
This utility was written by Benjamin Burton
<bab@maths.uq.edu.au>\&.
Many people have been involved in the development
of Regina; see the users' handbook for a full list of credits.