libflatsurf & pyflatsurf
libflatsurf is C++ library to work with translation surfaces and pyflatsurf is a low-level wrapper to use libflatsurf from Python.
If you came here looking for the flatsurf project, you probably want to start with sage-flatsurf which provides a unified interface to these and many other libraries in the SageMath computer algebra system.
We release this package regularly with rever; typically with every push to the master branch.
This repository contains two related projects:
Name | Downloads | Version | Platforms |
---|---|---|---|
You can install this package with conda. Download and install Mambaforge, then run
mamba create -n flatsurf -c flatsurf libflatsurf pyflatsurf
conda activate flatsurf
You can try out the projects in this repository in a very limited environment online by clicking the following links:
We are following a standard autoconf setup, i.e., you can create the library
libflatsurf/src
, and the Python wrapper pyflatsurf/src
with the following:
git clone --recurse-submodules https://github.com/flatsurf/flatsurf.git
cd flatsurf
./bootstrap
./configure
make
make check # to run our test suite
make install # to install into /usr/local
For best performance run CXXFLAGS="-O3 -flto -march=native -mtune=native" CXX="g++ -fno-semantic-interposition" ./configure
instead of ./configure
as
this code greatly benefits from flto inlining. (Unfortunately, libtool filters
out -fno-semantic-interposition
as of early 2019 so we can not pass it as
part of CXXFLAGS
. If you are using clang, -fno-semantic-interposition
does
not seem to be necessary.) Do not use -Ofast
or -ffast-math
as parts of our
code rely on IEEE compliance. You might want to add -g3
to the CXXFLAGS
which does not hurt performance but gives a better debugging experience. For
the best debugging experience, you might want to replace -O3
with -Og
or
even -O0
but the latter results in very poor performance.
Additionally, you might want to run configure with --disable-static
which improves the build time.
perf works well to profile
when you make sure that CXXFLAGS
contains -fno-omit-frame-pointer
. You can
then for example run our test suite with perf record --call-graph dwarf make check
Apart from perf itself there are several ways to analyze the output,
hotspot might be the most convenient one at
the time of this writing.
To build these packages, you need a fairly recent C++ compiler and probably some packages that might not be readily available on your system. If you don't want to use your distribution's packages, you can provide these dependencies with conda. Download and install Mambaforge, then run
git clone --recurse-submodules https://github.com/flatsurf/flatsurf.git
cd flatsurf
mamba create -n flatsurf-build
mamba env update -n flatsurf-build -f libflatsurf/environment.yml
mamba env update -n flatsurf-build -f pyflatsurf/environment.yml
conda activate flatsurf-build
./bootstrap
./configure
make
Note that the C++ compiler package from conda disabled all assertions. To
enable assertions export CPPFLAGS="$CPPFLAGS -UNDEBUG"
before running
configure and make.
For faster compile times, you might want to mamba install ccache
and set
export CXX="ccache c++"
before running configure and make.
The conda recipes in {lib,py}flatsurf/recipe/
are built automatically as part
of our Continuous Integration. If you want to build a recipe manually,
something like the following should work:
git clone --recurse-submodules https://github.com/flatsurf/flatsurf.git
cd flatsurf
conda activate root
conda config --add channels conda-forge
conda config --add channels flatsurf
conda install conda-build
conda build libflatsurf/recipe pyflatsurf/recipe
You can then try out the package that you just built with:
conda create -n flatsurf-test --use-local libflatsurf pyflatsurf
conda activate flatsurf-test
make check
runs all tests. During development make check TESTS=module
only
runs the tests for module
.
To build the benchmarks run make
in libflatsurf
. To run the
benchmarks, execute libflatsurf/benchmark/benchmark
.
Alternatively, the benchmarks can be run through
asv, e.g., with asv dev
.
In VPATH builds, you can use asv dev
by copying the asv.conf.json
over to
the VPATH and setting benchmark_dir
there to corresponding directory in the
original source tree. Then ASV_PROJECT_DIR=``pwd``/libflatsurf MAKEFLAGS="-j4" asv dev
should work as usual.
If you have used this project in the preparation of a publication, please cite it as described on our zenodo site.