The source code for SnapPy and its various parts are hosted on bitbucket as Mercurial repositories. To contribute a patch, create a free bitbucket account, fork the appropriate repository, and then send us a pull request, as described in this tutorial.
Here is how to get a clean development setup under OS X.
Install Active Tcl/Tk 8.6 from ActiveState.
Install the latest Python 2.7 from Python.org using the Mac Installer Disk Image. There are currently two versions, one for 10.3 and up (ppc/i386) and one for 10.6 and up (i386/x86_64); you want the second one. Set your path so that “python” is:
Python 2.7.9 and newer include pip so use it upgrade and install the following packages:
python -m pip install --upgrade setuptools python -m pip install virtualenv python -m pip install Cython # Used for Python-C interfacing python -m pip install Sphinx # For building the documentation python -m pip install ipython # Improved Python shell python -m pip install py2app # For making app bundles python -m pip install mercurial # Source code control software
Get the source code from the repository. The program “hg” was installed in the last step and lives in the same directory as Python 2.7:
hg clone https://bitbucket.org/t3m/PLink hg clone https://bitbucket.org/t3m/Spherogram hg clone https://bitbucket.org/t3m/CyPari hg clone https://bitbucket.org/t3m/SnapPy
Test the stand-alone link editor:
cd plink python setup.py install python -m plink.app # Link editor appears!
This last command runs the script “plink/app.py”; the real code for the link editor is in “plink/__init__.py”.
To make sure it’s using the right Tk, select “File->About Python...” and make sure the version is 8.6, not 8.4. or 8.5. If it’s an older version, go into “SnapPy/release_tools/tkinter-versions” and run the script ”./install_tkinter 8.6”. (If you don’t have both Python 3.2 and 2.7 installed on your system, it will complain. But you can ignore this.)
Build and install Spherogram:
cd ../Spherogram python setup.py install
Build and install CyPari:
cd ../CyPari python setup.py install
Now build SnapPy itself. One builds it twice to generate the documentation, much of which is extracted from the installed module:
cd ../SnapPy python setup.py install python setup.py build_docs install
If ”.” is in your path, you’ll need to change directory before starting SnapPy; otherwise it will attempt to load ”./snappy” which lacks the binary module:
cd SnapPyApp python -m snappy.app #SnapPy starts!
To build the clickable app, just do the following in the SnapPyApp directory:
python setup.py py2app
Some major parts of the SnapPy codebase are:
- “SnapPy.pyx”, “SnapPycore.pxi”, “SnapPy.pxi”: The Cython interface to the SnapPea kernel
- “opengl/CyOpenGL*.pyx”: The Cython interface to OpenGL*
- “snappy/app.py”: The core GUI code
- “snappy/polyviewer.py”: The GUI code for Dirichlet domains
- “snappy/horoviewer.py”: The GUI code for horoball pictures
- “snappy/database.py”: Interacts with the sqlite3 manifold database
In addition, Jeff’s old prototype for a Tk-based UI can be found in “misc/JeffsOldUI/SnapPeaGUI.py”; just run Python on this file to try it out, after installing PythonMegaWidgets.
These instructions have been tested on Windows 10, and describe setting up a development environment using the (free) MSVC compiler. To build the CyPari subcomponent, which few will want or need to do, one must install additional tools.
Install Python 2.7, specifically the 32 bit version (Windows x86 not Windows x86-64). Tested with version 2.7.13.
Install Python-specific free version of Microsoft Visual C++. If you would like to make your own installer you will also need Inno Setup; tested with version 5.5.9.
Install whichever version of MSYS2 is appropriate for your version Windows. Most commonly, you will have a 64-bit Windows and hence want the “x86_64” installer; for concreteness the rest of these instructions assume this. (Technical note: even if you want to build 32-bit binaries, if your Windows is 64-bit you want the x86_64 installer.) Follow the instructions on the webpage to update everything to the very latest MSYS2 (
pacman -Sy pacman; pacman -Syu; pacman -Suetc.).
Make a shortcut to
c:\msys64\msys2.exeas you will be using it all the time; alternatively, pin
mys2.exeto your taskbar.
Install some additional packages:
pacman -S git make nano openssh perl tar unzip wget winpty patch
Install your favorite text editor, for example you can install Emacs via:
pacman -S mingw-w64-x86_64-emacs
Make it so that MinGW, Python, and Inno Setup are all in your PATH, as well as work around some stupid bug, by making the end of your “~/.bash_profile” file to read:
PATH=/c/Python27:/c/Python27/Scripts:$PATH PATH=$PATH:'/c/Program Files (x86)/Inno Setup 5' export PATH alias emacs="/mingw64/bin/emacs" winpty bash; exit
For example, do:
Python 2.7.9 and newer include pip so let’s use it to install the needed packages.:
pip install --upgrade pip setuptools # Upgrades pip to the current version. pip install pyreadline sphinx cython cypari pip install pyx==0.12.1 pip install mercurial # Installs "hg", used in next step
Fetch the latest development versions of the source straight from the t3m repository:
hg clone https://bitbucket.org/t3m/plink hg clone https://bitbucket.org/t3m/Spherogram hg clone https://bitbucket.org/t3m/SnapPy
Build the components, from easiest to hardest, and then test:
cd plink python setup.py install cd ../Spherogram python setup.py install cd ../SnapPy python setup.py install cd .. python -m SnapPy.test
To run the app, you can just do:
python -m snappy.app
pip install PyInstaller-3.3.dev0+g483c819d.mod-py2-none-any.whl
To build the binary installer do:
cd windows_exe python make.py
You will need to close the SnapPy window that pops up here to complete the build process.
Useful tips for those coming from Unix. In MSYS2, your home directory is really something like:
whereas your Windows 10 home directory is:
It is handy to have symbolic links from your MSYS2 home directory to the Downloads and Desktop folders on the Windows side. See:
for a discussion, but basically you start a “Command Prompt” as Adminstrator and do:
cd "C:\msys64\home\Nathan Dunfield" mklink /D Desktop "C:\Users\Nathan Dunfield\Desktop" mklink /D Downloads "C:\Users\Nathan Dunfield\Downloads"
To build CyPari, first install the 32-bit gcc compiler:
pacman -S mingw-w64-i686-gcc Then open a *MinGW32 terminal window*, which is **different** than a MSYS2 terminal, and can be started via `c:\msys64\mingw32.exe`. This will put the 32-bit gcc in your path and set the correct "uname". Now do:: hg clone https://bitbucket.org/t3m/CyPari cd CyPari sh build_pari.sh python setup.py build --compiler=mingw32 python setup.py install python -m cypari.test # About 30 tests will fail. Warning: CyPari will not build if there are spaces in the path to the CyPari directory.