PrevCommand Line: Main Applications  Next

Name

regina-gui — Regina's graphical user interface

Synopsis

regina-gui [file...]

Description

Regina is a software package for 3-manifold and 4-manifold topologists, with a focus on triangulations, knots and links, normal surfaces, and angle structures. For 3-manifolds, it includes high-level tasks such as 3-sphere and unknot recognition, connected sum decomposition and Hakenness testing, comes with a rich database of census manifolds, and incorporates the SnapPea kernel for working with hyperbolic manifolds. For 4-manifolds, it offers a range of combinatorial and algebraic tools, plus support for normal hypersurfaces. For knots and links, Regina can perform combinatorial manipulation, compute knot polynomials, and work with several import/export formats. Regina comes with a full graphical user interface, as well as Python bindings and a low-level C++ programming interface.

This starts the full graphical user interface, and is the usual way of starting Regina. Any files passed on the command-line will be opened on startup.

Environment Variables

The following environment variables influence the behaviour of this program.

REGINA_PYLIBDIR

The directory containing the Python module regina.

If you have installed Regina's Python module in a standard Python location (i.e., Python can import it directly without extending sys.path), then REGINA_PYLIBDIR should be left empty or undefined.

Normally you should not need to set this option yourself. This program should know how to find Regina's Python module in standard situations, which include fixed filesystem installations (e.g., GNU/Linux and Windows), relocatable app bundles (e.g., macOS), and running directly from the source tree.

REGINA_HOME

The directory beneath which Regina's data files are installed. These include (amongst other things) example files in $REGINA_HOME/examples/, API documentation in $REGINA_HOME/engine-docs/, and census databases in $REGINA_HOME/data/census/.

Normally you should not need to set this option yourself. This program should know how to find its data files in standard situations, which include fixed filesystem installations (e.g., GNU/Linux and Windows), relocatable app bundles (e.g., macOS), and running directly from the source tree.

macOS Users

If you downloaded a drag-and-drop app bundle, this is the program that runs when you open it. The executable itself is simply called Regina, not regina-gui.

See Also

regina-python.

Regina comes with a rich users' handbook, which you can access via Help→Regina Handbook in the menu. You can also read the users' handbook online at regina-normal.github.io.

Author

Many people have been involved in the development of Regina; see the acknowledgements page for a full list of credits.

PrevContentsNext
Command Line: Main Applications Up regina-python