seidel 0.0.2

Randomized algorithm for trapezoidal decomposition by R. Seidel.

seidel

In what follows python is an alias for python3.5 or any later version (python3.6 and so on).

Installation

Install the latest pip & setuptools packages versions:

python -m pip install --upgrade pip setuptools

User

Download and install the latest stable version from PyPI repository:

python -m pip install --upgrade seidel

Developer

Download the latest version from GitHub repository

git clone https://github.com/lycantropos/seidel.git
cd seidel

Install dependencies:

python -m pip install --force-reinstall -r requirements.txt

Install:

python setup.py install

Usage

>>> from seidel.point import Point
>>> square = [Point(0, 0), Point(2, 0), Point(2, 2), Point(0, 2)]
>>> from seidel.trapezoidal_map import build_graph
>>> graph = build_graph(square, shuffle=True)
>>> node = graph.search_point(Point(1, 1))
>>> from seidel.leaf import Leaf
>>> isinstance(node, Leaf)
True
>>> trapezoid = node.trapezoid
>>> [trapezoid.below.left, trapezoid.below.right,
...  trapezoid.above.right, trapezoid.above.left] == square
True

original C++ implementation can be invoked by importing from _seidel module instead.

Development

Bumping version

Preparation

Install bump2version.

Pre-release

Choose which version number category to bump following semver specification.

Test bumping version

bump2version --dry-run --verbose $CATEGORY

where $CATEGORY is the target version number category name, possible values are patch/minor/major.

Bump version

bump2version --verbose $CATEGORY

This will set version to major.minor.patch-alpha.

Release

Test bumping version

bump2version --dry-run --verbose release

Bump version

bump2version --verbose release

This will set version to major.minor.patch.

Running tests

Install dependencies:

python -m pip install --force-reinstall -r requirements-tests.txt

Plain

pytest

Inside Docker container:

docker-compose up

Bash script (e.g. can be used in Git hooks):

./run-tests.sh

PowerShell script (e.g. can be used in Git hooks):

.\run-tests.ps1