Skip to content

Installation

Choose the path that matches your background. You do not need SageMath to use the browser interface or the core Python API.

  1. Install Python 3.9 or newer (Python 3.10+ is recommended) from python.org. On Windows, select Add Python to PATH.
  2. Download the stable v1.0.5 ZIP and extract it. Alternatively, install Git from git-scm.com and obtain that same version with:
git clone --branch v1.0.5 --depth 1 https://github.com/leonardofcavenaghi/atomicdecompositions.git

  1. Open a terminal in the extracted or cloned source folder.

  2. Create and activate an isolated environment:

py -m venv .venv
.venv\Scripts\Activate.ps1

python3 -m venv .venv
source .venv/bin/activate
  1. Install the project and its declared dependencies:
python -m pip install --upgrade pip
python -m pip install -e .
  1. Launch the local website:
python -m gwflags.gui --no-browser

Open http://127.0.0.1:8642. Stop the server with Ctrl-C.

Comfortable with Python

From a checkout, activate your existing environment and run python -m pip install -e .. Then use the GUI, CLI, or import FlagVariety in a script. Run a quick smoke test:

python -c "from gwflags import FlagVariety; print(FlagVariety('A2',[1]).dimension)"

To run the tests, install the optional test dependency first:

python -m pip install -e ".[test]"

Then run the full tests with:

python -m pytest tests/ -q

SageMath users

SageMath is optional. If it is installed, gwflags can use it for symbolic work; the plain Python installation above remains the supported baseline. On Windows, use WSL for SageMath and follow the Linux commands there.

Command-line and browser entry points

python -m gwflags.cli A2 --keep 1 sqm
python -m gwflags.gui --port 9000 --no-browser

For complete examples and input syntax, see How to Use. In the GUI, compact bundles use 3 or 1,1;2,2; Python code may use K=[[3]].

To build the documentation locally with the same pinned toolchain used by CI:

python -m pip install -r requirements-docs.txt
mkdocs build --strict