Regina: Software for 3-manifold topology and normal surface theory

Latest version: 4.93 (May 2012)

ContentsExtracts from the users' handbook
News
What is Regina?
Screenshots
Download
Documentation
What's new in version 4.93?
Announcement mailing list
Authors and license
Contact / Comments / Suggestions
What does Regina do?
Troubleshooting
Genealogy
Who is Regina?
Other pages
Census data and related articles
Building from source
Deprecation guide (for version 5.0)

News

29 July 2012: MacOS 10.8 (Mountain Lion) has arrived, and Regina works out of the box. However, since none of us are Apple registered developers, Mountain Lion might quarantine Regina and refuse to start it. To fix this, control-click on Regina and select Open, and you will be given an option to tell your machine that this application is safe.

30 May 2012: Version 4.93 is out! This is the version that will be presented at CG Week 2012. It adds one-click unknot recognition, veering structures, exports to Matveev's recogniser, Python improvements, and more. You can read more about what's new, or go ahead and download the new version.

12 April 2012: Version 4.92 is out: MacOS X users now have a simple drag-and-drop install, and there is now a version for Windows! Of course, GNU/Linux users are still well-supported as always. This version introduces fundamental normal surfaces, boundary slopes for spun-normal surfaces, and more; see the highlights here.

(Back to contents...)

What is Regina?

Regina is a suite of mathematical software for 3-manifold topologists. It focuses on the study of 3-manifold triangulations and normal surfaces.

Other highlights of Regina include angle structures, census enumeration, combinatorial recognition of triangulations, and high-level tasks such as 3-sphere recognition and connected sum decomposition. Regina comes with a full graphical user interface, and also offers Python bindings and a low-level C++ programming interface.

See the users' handbook for a full list of features.

(Back to contents...)

Screenshots

All of the screenshots below were taken with Regina 4.92 running on MacOS X. Click on each thumbnail for a full-sized version.

Screenshot thumbnail Studying 3-manifold triangulations
Screenshot thumbnail Normal surfaces and angle structures
Screenshot thumbnail In-built Python scripting

(Back to contents...)

Download

MacOS X

Regina on MacOS X uses a typical drag-and-drop installer: download and open the installer from the table below, and then drag Regina into your Applications folder (or wherever else you like).

Mountain Lion (10.8) users may be unable to start Regina because it is “from an unidentified developer” (none of us are registered with Apple). Control-click on Regina and select Open, and you will be given an option to tell your machine that this application is safe.

MacOS VersionInstaller
Mountain Lion (10.8)
Lion (10.7)
Snow Leopard (10.6) on modern 64-bit machines
Download
Snow Leopard (10.6) on older 32-bit machines
Leopard (10.5)
  Download

Most Snow Leopard users should be able to run the 64-bit Lion package. If your machine is very old, you might get an error message ‘You can't open the application "Regina" because it is not supported on this architecture’. In this case, you can run the 32-bit Leopard package instead.

Windows

Regina on Windows uses a standard point-and-click installer.

Windows VersionInstaller
Windows 7
Windows Vista
Windows XP (see below)
Download

On some Windows XP machines, Regina will not start (“The application failed to initialize properly ...”). The problem seems to be an obscure missing DLL, and the error message is spectacularly unhelpful; one known solution is to install Python 2.x from python.org.

GNU/Linux

You can download ready-made packages for several GNU/Linux distributions. All of these packages are named regina-normal (to avoid conflicting with the other Regina). Please click on the Download link for your system in the table below.

To keep the installation simple, most packages do not include the MPI (high-performance computing) utilities. If you need these, let Ben know and he can build you an MPI-enabled package.

Distribution Version 32-bit package (i386 or i586) 64-bit package (amd64 or x86_64)
Debian 6.0 (squeeze) Install Install
unstable (sid) Install Install
Fedora 17 Download Download
16 Download Download
15 Download Download
14 Download Download
Mandriva 2011.0 Download Download
2010.2 Download Download
2010.1 Download Download
openSUSE 12.1 Download Download
11.4 Download Download
11.3 Download Download
Ubuntu 12.04 LTS (precise) Install Install
11.10 (oneiric) Install Install
11.04 (natty) Install Install
10.10 (maverick) Install Install
10.04 LTS (lucid) Install Install

If your system is not in this table, you will need to build Regina from source. You can download the source code here. Please see the separate page on building Regina for instructions on how to build Regina and what libraries and tools you will need to have installed.

If you run into any problems when you run Regina, you can check the troubleshooting page to see if your problem is discussed there. You also most welcome to contact us for help.

(Back to contents...)

Documentation

Regina comes with rich documentation for both users and developers.

Users' Handbook

The Regina Handbook is full of screenshots, and walks you through the different things that Regina can do. The handbook was completely refurbished for Regina 4.90, so you might want to take a fresh look.

You can read the handbook from within Regina by selecting Help → Regina Handbook from the menu. You can also read it here online.

Python/C++ API Documentation

If you are doing Python scripting or C++ programming with Regina, there is extensive API documentation for Regina's mathematical engine. This describes the various objects, classes and functions that Regina makes available to you.

You can read the API documentation by selecting Help → Python API Reference from the menu. You can also read it here online.

(Back to contents...)

What's new in version 4.93 (May 2012)?

Some of the main highlights in version 4.93:

Features

User Interface

Python

This also builds upon the recent version 4.92 (April 2012), whose major changes are listed below.

(Back to contents...)

Highlights from version 4.92 (April 2012)

Some of the main highlights from the previous version 4.92:

Installation

User Interface

Features

Python

(Back to contents...)

Announcement Mailing List

You are welcome to subscribe to the announcement list regina-announce@lists.sourceforge.net. This is a moderated list with extremely low traffic, and is only used for major announcements such as new releases of Regina. You can subscribe or unsubscribe here.

There are other mailing lists for user support and development; click here for details.

(Back to contents...)

Authors and License

The primary developers of Regina are Benjamin Burton, Ryan Budney, and William Pettersson.

Many others have been of assistance with this project, be it through time, knowledge, testing or code. Please see the full list of acknowledgements in the users' handbook.

Citation

If you find Regina useful in your research, please consider citing it as you would any other paper that you use. A suggested form of reference is:
Benjamin A. Burton, Ryan Budney, William Pettersson, et al.,
Regina: Software for 3-manifold topology and normal surface theory,
http://regina.sourceforge.net/, 1999–2012.

Copying & modification

Regina is copyright © 1999–2012, The Regina development team.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.

Detailed License

Regina includes portions of external software for specialised tasks (such as code from SnapPea and SnapPy for some geometric calculations, and code from Normaliz for computing Hilbert bases).

For complete license details, including the full GNU General Public License and information on external software that Regina uses, see the full license in the users' handbook.

Project Hosting

SourceForge We are grateful to SourceForge.net for hosting this project on their servers.

(Back to contents...)

Contact / Comments / Suggestions

If you have any suggestions, problems, bugs, wishes, frustrations or otherwise miscellaneous comments, we would really love to hear them. This program is permanently under development and we would like to know what people want out of it.

If you have written your own extensions that you think could be worth putting in the main release, please do write and let us know.

Even if you have no comments to make, it's always nice to hear from people using Regina, even if it's just to say hi. We're always interested to hear how this software is being used.

You can contact us by email: the best address is regina-user@lists.sourceforge.net, which will reach all of the developers. Of course you are also welcome to send us personal emails: our websites are linked to our names in the author list above.

(Back to contents...)