ground

KO | EN

gitlite — search

#javascript #python #react #typescript #golang #docker #nodejs #cli #kubernetes #awesome-list #security #mcp #ios #openai

(★ 8)

Basis of computational geometry

ground Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ground

[![Github Actions](https://github.com/lycantropos/ground/workflows/CI/badge.svg)](https://github.com/lycantropos/ground/actions/workflows/ci.yml "Github Actions")
[![Codecov](https://codecov.io/gh/lycantropos/ground/branch/master/graph/badge.svg)](https://codecov.io/gh/lycantropos/ground "Codecov")
[![Documentation](https://readthedocs.org/projects/ground/badge/?version=latest)](https://ground.readthedocs.io/en/latest "Documentation")
[![License](https://img.shields.io/github/license/lycantropos/ground.svg)](https://github.com/lycantropos/ground/blob/master/LICENSE "License")
[![PyPI](https://badge.fury.io/py/ground.svg)](https://badge.fury.io/py/ground "PyPI")

In what follows `python` is an alias for `python3.10` or `pypy3.10`
or any later version (`python3.11`, `pypy3.11` and so on).

## Installation

### Prerequisites

Install the latest `pip` & `setuptools` packages versions

```bash
python -m pip install --upgrade pip setuptools
```

### User

Download and install the latest stable version from `PyPI` repository

```bash
python -m pip install --upgrade ground
```

### Developer

Download the latest version from `GitHub` repository

```bash
git clone https://github.com/lycantropos/ground.git
cd ground
```

Install

```bash
python -m pip install -e '.'
```

## Usage

```python
>>> import math
>>> from fractions import Fraction
>>> from ground.context import Context
>>> context = Context(coordinate_factory=Fraction, sqrt=math.sqrt)
>>> Multipoint = context.multipoint_cls
>>> Point = context.point_cls
>>> Segment = context.segment_cls
>>> x_unit = Point(1, 0)
>>> y_unit = Point(0, 1)
>>> from ground.enums import Kind
>>> context.angle_kind(context.origin, x_unit, y_unit) is Kind.RIGHT
True
>>> from ground.enums import Orientation
>>> context.angle_orientation(
...     context.origin, x_unit, y_unit
... ) is Orientation.COUNTERCLOCKWISE
True
>>> context.cross_product(context.origin, x_unit, context.origin, y_unit) == 1
True
>>> context.dot_product(context.origin, x_unit, context.origin, y_unit) == 0
True
>>> context.multipoint_centroid(Multipoint([context.origin])) == context.origin
True
>>> context.points_convex_hull([context.origin, x_unit, y_unit]) == [
...   context.origin,
...   x_unit,
...   y_unit,
... ]
True
>>> context.segment_contains_point(Segment(context.origin, x_unit), y_unit)
False
>>> context.segment_contains_point(
...     Segment(context.origin, x_unit), context.origin
... )
True
>>> context.segments_intersection(
...     Segment(context.origin, x_unit), Segment(context.origin, y_unit)
... ) == context.origin
True
>>> from ground.enums import Relation
>>> context.segments_relation(
...     Segment(context.origin, x_unit), Segment(context.origin, y_unit)
... ) is Relation.TOUCH
True

```

## Development

### Bumping version

#### Prerequisites

Install [bump-my-version](https://github.com/callowayproject/bump-my-version#installation).

#### Release

Choose which version number category to bump following [semver
specification](http://semver.org/).

Test bumping version

```bash
bump-my-version bump --dry-run --verbose $CATEGORY
```

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

Bump version

```bash
bump-my-version bump --verbose $CATEGORY
```

This will set version to `major.minor.patch`.

### Running tests

#### Plain

Install with dependencies

```bash
python -m pip install -e '.[tests]'
```

Run

```bash
pytest
```

#### `Docker` container

Run

- with `CPython`

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

- with `PyPy`

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

#### `Bash` script

Run

- with `CPython`

```bash
  ./run-tests.sh
  ```

```bash
  ./run-tests.sh cpython
  ```

- with `PyPy`

```bash
  ./run-tests.sh pypy
  ```

#### `PowerShell` script

Run

- with `CPython`

```powershell
  .\run-tests.ps1
  ```

```powershell
  .\run-tests.ps1 cpython
  ```

- with `PyPy`

```powershell
  .\run-tests.ps1 pypy
  ```

ground

ground Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ground

ground Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README