Skip to content

Commit f5adc11

Browse files
committed
Replaces DESCRIPTION.txt
1 parent db7bacb commit f5adc11

File tree

2 files changed

+15
-8
lines changed

2 files changed

+15
-8
lines changed

DESCRIPTION.txt

Lines changed: 0 additions & 4 deletions
This file was deleted.

setup.py

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,27 @@
11
from setuptools import setup
22

3-
with open('DESCRIPTION.txt') as f:
4-
long_description = f.read()
3+
LONG_DESCRIPTION = """
4+
Ordinal hashing of multidimensonal data and geographic coordinates via Morton coding / Z-ordering.
5+
6+
In mathematical analysis and computer science, `Z-order`, `Morton-order`, or a `Morton-code` is a function
7+
which maps multidimensional data to one dimension while preserving locality of the data points.
8+
It was introduced in 1966 by IBM researcher, G. M. Morton. The z-value of a point in multidimensions is
9+
calculated by interleaving the binary representations of its coordinate values. Once the data are sorted
10+
into this ordering, any one-dimensional data structure can be used, such as binary search trees, B-trees,
11+
skip lists, or hash tables. The resulting ordering can equivalently be described as the order one would
12+
achieve from a depth-first traversal of a quadtree, where `{x, y, ..., K}` are combined into a single
13+
ordinal value that is easily compared, searched, and indexed against other Morton numbers.
14+
"""
15+
516

617
def build():
718
setup(
819
name='pymorton',
9-
version='1.0.4',
20+
version='1.0.5',
1021
author='Trevor Prater',
1122
author_email='trevor.prater@gmail.com',
1223
description='A lightweight morton coder with lat/long support.',
13-
long_description=long_description,
24+
long_description=LONG_DESCRIPTION,
1425
license='MIT',
1526
keywords='nearest neighbors, geo hashing, geo, z-order, morton coding, hashing',
1627
url='https://github.com/trevorprater/pymorton',

0 commit comments

Comments
 (0)