sect

In what follows python is an alias for python3.7 or pypy3.7 or any later version (python3.8, pypy3.8 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 sect

Developer

Download the latest version from GitHub repository

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

Install dependencies

python -m pip install -r requirements.txt

Install

python setup.py install

Usage

>>> from ground.base import get_context
>>> from sect.triangulation import Triangulation
>>> context = get_context()
>>> Contour, Point = context.contour_cls, context.point_cls
>>> (Triangulation.delaunay([Point(0, 0), Point(1, 0), Point(0, 1)],
...                         context=context).triangles()
...  == [Contour([Point(0, 0), Point(1, 0), Point(0, 1)])])
True
>>> (Triangulation.delaunay([Point(0, 0), Point(3, 0), Point(1, 1),
...                          Point(0, 3)],
...                         context=context).triangles()
...  == [Contour([Point(0, 0), Point(3, 0), Point(1, 1)]),
...      Contour([Point(0, 0), Point(1, 1), Point(0, 3)]),
...      Contour([Point(0, 3), Point(1, 1), Point(3, 0)])])
True
>>> (Triangulation.delaunay([Point(0, 0), Point(1, 0), Point(1, 1),
...                          Point(0, 1)],
...                         context=context).triangles()
...  == [Contour([Point(0, 1), Point(1, 0), Point(1, 1)]),
...      Contour([Point(0, 0), Point(1, 0), Point(0, 1)])])
True
>>> Polygon = context.polygon_cls
>>> (
...      Triangulation.constrained_delaunay(
...          Polygon(Contour([Point(0, 0), Point(1, 0), Point(0, 1)]), []),
...          context=context
...      ).triangles()
...      == [Contour([Point(0, 0), Point(1, 0), Point(0, 1)])]
... )
True
>>> (
...      Triangulation.constrained_delaunay(
...          Polygon(Contour([Point(0, 0), Point(3, 0), Point(1, 1),
...                           Point(0, 3)]),
...                  []),
...          context=context
...      ).triangles()
...      == [Contour([Point(0, 0), Point(3, 0), Point(1, 1)]),
...          Contour([Point(0, 0), Point(1, 1), Point(0, 3)])]
... )
True
>>> (
...      Triangulation.constrained_delaunay(
...          Polygon(Contour([Point(0, 0), Point(4, 0), Point(0, 4)]),
...                  [Contour([Point(0, 0), Point(1, 2), Point(2, 1)])]),
...          context=context
...      ).triangles()
...      == [Contour([Point(0, 0), Point(4, 0), Point(2, 1)]),
...          Contour([Point(1, 2), Point(2, 1), Point(4, 0)]),
...          Contour([Point(0, 4), Point(1, 2), Point(4, 0)]),
...          Contour([Point(0, 0), Point(1, 2), Point(0, 4)])]
... )
True
>>> from sect.decomposition import Graph
>>> graph = Graph.from_polygon(Polygon(Contour([Point(0, 0), Point(6, 0),
...                                             Point(6, 6), Point(0, 6)]),
...                                    [Contour([Point(2, 2), Point(2, 4),
...                                              Point(4, 4), Point(4, 2)])]),
...                            context=context)
>>> Point(0, 0) in graph
True
>>> Point(1, 1) in graph
True
>>> Point(2, 2) in graph
True
>>> Point(3, 3) in graph
False
>>> from ground.base import Location
>>> graph.locate(Point(0, 0)) is Location.BOUNDARY
True
>>> graph.locate(Point(1, 1)) is Location.INTERIOR
True
>>> graph.locate(Point(2, 2)) is Location.BOUNDARY
True
>>> graph.locate(Point(3, 3)) is Location.EXTERIOR
True

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 -r requirements-tests.txt

Plain

pytest

Inside Docker container:

with CPython

docker-compose --file docker-compose.cpython.yml up

with PyPy

docker-compose --file docker-compose.pypy.yml up

Bash script:

with CPython
```
./run-tests.sh
```
or
```
./run-tests.sh cpython
```
with PyPy
```
./run-tests.sh pypy
```

PowerShell script:

with CPython
```
.\run-tests.ps1
```
or
```
.\run-tests.ps1 cpython
```
with PyPy
```
.\run-tests.ps1 pypy
```