Skip to main content

A Python library for computing regular triangulations of lattice vector configurations

Project description

Fan flip graph

regfans

regfans is a Python library for studying lattice vector configurations, developed by Nate MacFadden at the Liam McAllister Group at Cornell.

DOI

Used by CYTools.

Core Functionality

The library computes and modifies regular triangulations of vector configurations. These could also be known as "regular polyhedral fans" or "vex triangulations".

Key capabilities:

  • Verify properties of vector configurations (solid, totally-cyclic) and fans (fine, regular, point-configuration-compatible),
  • Construct regular triangulations via lifting,
  • Compute all (regular) triangulations via flip graph traversal, and
  • Perform efficient linear flips.

See Triangulations: Structures for Algorithms and Applications by De Loera, Rambau, and Santos for a definitive reference on such topics. It is a wonderful book.

regfans has a lot of overlap with TOPCOM; regfans will port over more computations to TOPCOM as beneficial for speed (via triangulumancer).

Installation

Install via conda (most robust across platforms):

conda env create -f environment.yml
conda activate regfans
pip install -e .

Or via pip (see also PyPI listing):

pip install regfans

Note: Most methods require dual cone computation via pplpy. On macOS and Linux x86_64, pip install pulls a prebuilt pplpy wheel automatically (no system libraries needed). On other platforms (Windows, or ARM/musl Linux on older Pythons) there is no wheel and pip falls back to a source build that needs the ppl/gmp C libraries; the conda environment supplies those reliably.

Primary Interface

The main class is VectorConfiguration:

from regfans import VectorConfiguration

pts = [[1, -2, -1, -1], [1, 1, -1, 2], [-2, 0, 0, -1],
       [0, 0, 1, 0], [0, 1, 0, 0], [0, 0, 0, 1]]
vc = VectorConfiguration(pts)

# construct a regular triangulation via lifting
fan = vc.subdivide()
print(fan.is_fine(), fan.is_regular())

# compute all triangulations and the flip graph
all_fans = vc.all_triangulations()
G, fans, labels = vc.flip_graph(compute_node_labels=True)

See documentation/api.md for the full API reference and the tutorials directory for annotated examples.

Citation

If you are using regfans for toric-geometric or Calabi-Yau applications, please cite Calabi-Yau Threefolds from Vex Triangulations:

@article{MacFadden:2512.14817,
  author  = {MacFadden, Nate and Sheridan, Elijah},
  title   = {Calabi-{Y}au Threefolds from Vex Triangulations},
  doi     = {10.48550/arXiv.2512.14817},
  url     = {https://arxiv.org/abs/2512.14817},
}

Otherwise, please cite this repository:

@software{regfans,
  author  = {MacFadden, Nate},
  title   = {regfans},
  doi     = {10.5281/zenodo.19406101},
  url     = {https://github.com/natemacfadden/regfans},
  orcid   = {0000-0002-8481-3724},
}

This package was developed for constructing toric varieties in Calabi-Yau Threefolds from Vex Triangulations, supported in part by NSF grant PHY-2309456. Toric-geometric computations are provided by CYTools, which extends regfans via a vector_config module.

Organization

regfans/
├── src/regfans/
│   ├── vectorconfig.py   # VectorConfiguration class: triangulations, flip graph, VC properties
│   ├── fan.py            # Fan class: triangulation of a vector configuration
│   ├── circuits.py       # Circuit and Circuits classes
│   └── util.py           # shared utilities for vector configuration computations
├── tests/
│   ├── test_vectorconfig.py   # tests for VectorConfiguration
│   ├── test_fan.py            # tests for Fan
│   ├── test_circuits.py       # tests for circuits
│   └── test_util.py           # tests for utilities
├── tutorials/
│   ├── simple_lifting_ex.py   # constructing a regular triangulation via lifting
│   └── all_fans_ex.py         # computing all triangulations and the flip graph
├── documentation/
│   ├── api.md                 # full API reference
│   └── clean_api.py           # script to generate api.md
└── pyproject.toml

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

regfans-0.2.0.tar.gz (55.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

regfans-0.2.0-py3-none-any.whl (52.1 kB view details)

Uploaded Python 3

File details

Details for the file regfans-0.2.0.tar.gz.

File metadata

  • Download URL: regfans-0.2.0.tar.gz
  • Upload date:
  • Size: 55.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for regfans-0.2.0.tar.gz
Algorithm Hash digest
SHA256 6927c1feb60504b49c8e0aa291b5d0a8cb591662315ce7e85ad272f99ad9334e
MD5 c837baf043bbcdcd25e5ce7ffe963a8c
BLAKE2b-256 cf07563d3c8afd81cf4f0c071d2332a19ca70936c5d9bdd12c20f97ccbb98407

See more details on using hashes here.

Provenance

The following attestation bundles were made for regfans-0.2.0.tar.gz:

Publisher: publish.yml on natemacfadden/regfans

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file regfans-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: regfans-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 52.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for regfans-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c85125fda0b466ad48f7194c5c7cd1f49dd8785a57bfb50ee0e4f982b3050ddc
MD5 d511b67e0391a3eb59ea1dddb1624622
BLAKE2b-256 5458d11babdce70393348c6e44d69f5c8aa3a7748edf2a3c0990b72e6f0e3a47

See more details on using hashes here.

Provenance

The following attestation bundles were made for regfans-0.2.0-py3-none-any.whl:

Publisher: publish.yml on natemacfadden/regfans

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page