scikit-spatial 7.2.0__tar.gz → 8.0.0__tar.gz

scikit_spatial-8.0.0/AUTHORS.rst

@@ -0,0 +1,16 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Andrew Hynes (https://github.com/ajhynes7)
+
+
+Contributors
+------------
+
+* Marcelo Moreno (https://github.com/martxelo)
+
+* Cristiano Pizzamiglio (https://github.com/CristianoPizzamiglio)

scikit_spatial-8.0.0/PKG-INFO

@@ -0,0 +1,276 @@
+Metadata-Version: 2.1
+Name: scikit-spatial
+Version: 8.0.0
+Summary: Spatial objects and computations based on NumPy arrays.
+Author-email: Andrew Hynes <andrewjhynes@gmail.com>
+License: BSD-3-Clause
+Project-URL: repository, https://github.com/ajhynes7/scikit-spatial
+Project-URL: documentation, https://scikit-spatial.readthedocs.io
+Keywords: NumPy,matplotlib,visualization,spatial,linear algebra
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: matplotlib>=3
+Requires-Dist: numpy>=1.24
+Requires-Dist: scipy>=1.9
+
+![](images/logo.svg)
+
+[![image](https://img.shields.io/pypi/v/scikit-spatial.svg)](https://pypi.python.org/pypi/scikit-spatial)
+[![image](https://anaconda.org/conda-forge/scikit-spatial/badges/version.svg)](https://anaconda.org/conda-forge/scikit-spatial)
+[![image](https://img.shields.io/pypi/pyversions/scikit-spatial.svg)](https://pypi.python.org/pypi/scikit-spatial)
+[![image](https://github.com/ajhynes7/scikit-spatial/actions/workflows/main.yml/badge.svg)](https://github.com/ajhynes7/scikit-spatial/actions/workflows/main.yml)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ajhynes7/scikit-spatial/master.svg)](https://results.pre-commit.ci/latest/github/ajhynes7/scikit-spatial/master)
+[![Documentation Status](https://readthedocs.org/projects/scikit-spatial/badge/?version=latest)](https://scikit-spatial.readthedocs.io/en/latest/?badge=latest)
+[![image](https://codecov.io/gh/ajhynes7/scikit-spatial/branch/master/graph/badge.svg)](https://codecov.io/gh/ajhynes7/scikit-spatial)
+
+# Introduction
+
+This package provides spatial objects based on NumPy arrays, as well as
+computations using these objects. The package includes computations for
+2D, 3D, and higher-dimensional space.
+
+The following spatial objects are provided:
+
+- Point
+- Points
+- Vector
+- Line
+- LineSegment
+- Plane
+- Circle
+- Sphere
+- Triangle
+- Cylinder
+
+Most of the computations fall into the following categories:
+
+- Measurement
+- Comparison
+- Projection
+- Intersection
+- Fitting
+- Transformation
+
+All spatial objects are equipped with plotting methods based on
+`matplotlib`. Both 2D and 3D plotting are supported. Spatial
+computations can be easily visualized by plotting multiple objects at
+once.
+
+## Why this instead of `scipy.spatial` or `sympy.geometry`?
+
+This package has little to no overlap with the functionality of
+`scipy.spatial`. It can be viewed as an object-oriented extension.
+
+While similar spatial objects and computations exist in the
+`sympy.geometry` module, `scikit-spatial` is based on NumPy rather than
+symbolic math. The primary objects of `scikit-spatial` (`Point`,
+`Points`, and `Vector`) are actually subclasses of the NumPy _ndarray_.
+This gives them all the regular functionality of the _ndarray_, plus
+additional methods from this package.
+
+```py
+>>> from skspatial.objects import Vector
+
+>>> vector = Vector([2, 0, 0])
+
+```
+
+Behaviour inherited from NumPy:
+
+```py
+>>> vector.size
+3
+
+>>> vector.mean().round(3)
+np.float64(0.667)
+
+```
+
+Additional methods from `scikit-spatial`:
+
+```py
+>>> vector.norm()
+np.float64(2.0)
+
+>>> vector.unit()
+Vector([1., 0., 0.])
+
+```
+
+Because `Point` and `Vector` are both subclasses of `ndarray`, a `Vector` can be added to a `Point`. This produces a new `Point`.
+
+```py
+>>> from skspatial.objects import Point
+
+>>> Point([1, 2]) + Vector([3, 4])
+Point([4, 6])
+
+```
+
+`Point` and `Vector` are based on a 1D NumPy array, and `Points` is
+based on a 2D NumPy array, where each row represents a point in space.
+The `Line` and `Plane` objects have `Point` and `Vector` objects as
+attributes.
+
+Note that most methods inherited from NumPy return a regular NumPy object,
+instead of the spatial object class.
+
+```py
+>>> vector.sum()
+np.int64(2)
+
+```
+
+This is to avoid getting a spatial object with a forbidden shape, like a
+zero dimension `Vector`. Trying to convert this back to a `Vector`
+causes an exception.
+
+```py
+>>> Vector(vector.sum())
+Traceback (most recent call last):
+ValueError: The array must be 1D.
+
+```
+
+Because the computations of `scikit-spatial` are also based on NumPy,
+keyword arguments can be passed to NumPy functions. For example, a
+tolerance can be specified while testing for collinearity. The `tol`
+keyword is passed to `numpy.linalg.matrix_rank`.
+
+```py
+>>> from skspatial.objects import Points
+
+>>> points = Points([[1, 2, 3], [4, 5, 6], [7, 8, 8]])
+
+>>> points.are_collinear()
+False
+
+>>> points.are_collinear(tol=1)
+True
+
+```
+
+# Installation
+
+The package can be installed with pip.
+
+```bash
+$ pip install scikit-spatial
+
+```
+
+It can also be installed with conda.
+
+```bash
+$ conda install scikit-spatial -c conda-forge
+
+```
+
+# Example Usage
+
+## Measurement
+
+Measure the cosine similarity between two vectors.
+
+```py
+>>> from skspatial.objects import Vector
+
+>>> Vector([1, 0]).cosine_similarity([1, 1]).round(3)
+np.float64(0.707)
+
+```
+
+## Comparison
+
+Check if multiple points are collinear.
+
+```py
+>>> from skspatial.objects import Points
+
+>>> points = Points([[1, 2, 3, 4], [5, 6, 7, 8], [9, 10, 11, 12]])
+
+>>> points.are_collinear()
+True
+
+```
+
+## Projection
+
+Project a point onto a line.
+
+```py
+>>> from skspatial.objects import Line
+
+>>> line = Line(point=[0, 0, 0], direction=[1, 1, 0])
+
+>>> line.project_point([5, 6, 7])
+Point([5.5, 5.5, 0. ])
+
+```
+
+## Intersection
+
+Find the intersection of two planes.
+
+```py
+>>> from skspatial.objects import Plane
+
+>>> plane_a = Plane(point=[0, 0, 0], normal=[0, 0, 1])
+>>> plane_b = Plane(point=[5, 16, -94], normal=[1, 0, 0])
+
+>>> plane_a.intersect_plane(plane_b)
+Line(point=Point([5., 0., 0.]), direction=Vector([0, 1, 0]))
+
+```
+
+An error is raised if the computation is undefined.
+
+```py
+>>> plane_b = Plane(point=[0, 0, 1], normal=[0, 0, 1])
+
+>>> plane_a.intersect_plane(plane_b)
+Traceback (most recent call last):
+ValueError: The planes must not be parallel.
+
+```
+
+## Fitting
+
+Find the plane of best fit for multiple points.
+
+```py
+>>> points = [[0, 0, 0], [1, 0, 0], [0, 1, 0], [1, 1, 0]]
+
+>>> Plane.best_fit(points)
+Plane(point=Point([0.5, 0.5, 0. ]), normal=Vector([0., 0., 1.]))
+
+```
+
+## Transformation
+
+Transform multiple points to 1D coordinates along a line.
+
+```py
+>>> line = Line(point=[0, 0, 0], direction=[1, 2, 0])
+>>> points = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]
+
+>>> line.transform_points(points).round(3)
+array([ 2.236,  6.261, 10.286])
+
+```
+
+# Acknowledgment
+
+This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template.

scikit_spatial-8.0.0/README.md

@@ -0,0 +1,249 @@
+![](images/logo.svg)
+
+[![image](https://img.shields.io/pypi/v/scikit-spatial.svg)](https://pypi.python.org/pypi/scikit-spatial)
+[![image](https://anaconda.org/conda-forge/scikit-spatial/badges/version.svg)](https://anaconda.org/conda-forge/scikit-spatial)
+[![image](https://img.shields.io/pypi/pyversions/scikit-spatial.svg)](https://pypi.python.org/pypi/scikit-spatial)
+[![image](https://github.com/ajhynes7/scikit-spatial/actions/workflows/main.yml/badge.svg)](https://github.com/ajhynes7/scikit-spatial/actions/workflows/main.yml)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ajhynes7/scikit-spatial/master.svg)](https://results.pre-commit.ci/latest/github/ajhynes7/scikit-spatial/master)
+[![Documentation Status](https://readthedocs.org/projects/scikit-spatial/badge/?version=latest)](https://scikit-spatial.readthedocs.io/en/latest/?badge=latest)
+[![image](https://codecov.io/gh/ajhynes7/scikit-spatial/branch/master/graph/badge.svg)](https://codecov.io/gh/ajhynes7/scikit-spatial)
+
+# Introduction
+
+This package provides spatial objects based on NumPy arrays, as well as
+computations using these objects. The package includes computations for
+2D, 3D, and higher-dimensional space.
+
+The following spatial objects are provided:
+
+- Point
+- Points
+- Vector
+- Line
+- LineSegment
+- Plane
+- Circle
+- Sphere
+- Triangle
+- Cylinder
+
+Most of the computations fall into the following categories:
+
+- Measurement
+- Comparison
+- Projection
+- Intersection
+- Fitting
+- Transformation
+
+All spatial objects are equipped with plotting methods based on
+`matplotlib`. Both 2D and 3D plotting are supported. Spatial
+computations can be easily visualized by plotting multiple objects at
+once.
+
+## Why this instead of `scipy.spatial` or `sympy.geometry`?
+
+This package has little to no overlap with the functionality of
+`scipy.spatial`. It can be viewed as an object-oriented extension.
+
+While similar spatial objects and computations exist in the
+`sympy.geometry` module, `scikit-spatial` is based on NumPy rather than
+symbolic math. The primary objects of `scikit-spatial` (`Point`,
+`Points`, and `Vector`) are actually subclasses of the NumPy _ndarray_.
+This gives them all the regular functionality of the _ndarray_, plus
+additional methods from this package.
+
+```py
+>>> from skspatial.objects import Vector
+
+>>> vector = Vector([2, 0, 0])
+
+```
+
+Behaviour inherited from NumPy:
+
+```py
+>>> vector.size
+3
+
+>>> vector.mean().round(3)
+np.float64(0.667)
+
+```
+
+Additional methods from `scikit-spatial`:
+
+```py
+>>> vector.norm()
+np.float64(2.0)
+
+>>> vector.unit()
+Vector([1., 0., 0.])
+
+```
+
+Because `Point` and `Vector` are both subclasses of `ndarray`, a `Vector` can be added to a `Point`. This produces a new `Point`.
+
+```py
+>>> from skspatial.objects import Point
+
+>>> Point([1, 2]) + Vector([3, 4])
+Point([4, 6])
+
+```
+
+`Point` and `Vector` are based on a 1D NumPy array, and `Points` is
+based on a 2D NumPy array, where each row represents a point in space.
+The `Line` and `Plane` objects have `Point` and `Vector` objects as
+attributes.
+
+Note that most methods inherited from NumPy return a regular NumPy object,
+instead of the spatial object class.
+
+```py
+>>> vector.sum()
+np.int64(2)
+
+```
+
+This is to avoid getting a spatial object with a forbidden shape, like a
+zero dimension `Vector`. Trying to convert this back to a `Vector`
+causes an exception.
+
+```py
+>>> Vector(vector.sum())
+Traceback (most recent call last):
+ValueError: The array must be 1D.
+
+```
+
+Because the computations of `scikit-spatial` are also based on NumPy,
+keyword arguments can be passed to NumPy functions. For example, a
+tolerance can be specified while testing for collinearity. The `tol`
+keyword is passed to `numpy.linalg.matrix_rank`.
+
+```py
+>>> from skspatial.objects import Points
+
+>>> points = Points([[1, 2, 3], [4, 5, 6], [7, 8, 8]])
+
+>>> points.are_collinear()
+False
+
+>>> points.are_collinear(tol=1)
+True
+
+```
+
+# Installation
+
+The package can be installed with pip.
+
+```bash
+$ pip install scikit-spatial
+
+```
+
+It can also be installed with conda.
+
+```bash
+$ conda install scikit-spatial -c conda-forge
+
+```
+
+# Example Usage
+
+## Measurement
+
+Measure the cosine similarity between two vectors.
+
+```py
+>>> from skspatial.objects import Vector
+
+>>> Vector([1, 0]).cosine_similarity([1, 1]).round(3)
+np.float64(0.707)
+
+```
+
+## Comparison
+
+Check if multiple points are collinear.
+
+```py
+>>> from skspatial.objects import Points
+
+>>> points = Points([[1, 2, 3, 4], [5, 6, 7, 8], [9, 10, 11, 12]])
+
+>>> points.are_collinear()
+True
+
+```
+
+## Projection
+
+Project a point onto a line.
+
+```py
+>>> from skspatial.objects import Line
+
+>>> line = Line(point=[0, 0, 0], direction=[1, 1, 0])
+
+>>> line.project_point([5, 6, 7])
+Point([5.5, 5.5, 0. ])
+
+```
+
+## Intersection
+
+Find the intersection of two planes.
+
+```py
+>>> from skspatial.objects import Plane
+
+>>> plane_a = Plane(point=[0, 0, 0], normal=[0, 0, 1])
+>>> plane_b = Plane(point=[5, 16, -94], normal=[1, 0, 0])
+
+>>> plane_a.intersect_plane(plane_b)
+Line(point=Point([5., 0., 0.]), direction=Vector([0, 1, 0]))
+
+```
+
+An error is raised if the computation is undefined.
+
+```py
+>>> plane_b = Plane(point=[0, 0, 1], normal=[0, 0, 1])
+
+>>> plane_a.intersect_plane(plane_b)
+Traceback (most recent call last):
+ValueError: The planes must not be parallel.
+
+```
+
+## Fitting
+
+Find the plane of best fit for multiple points.
+
+```py
+>>> points = [[0, 0, 0], [1, 0, 0], [0, 1, 0], [1, 1, 0]]
+
+>>> Plane.best_fit(points)
+Plane(point=Point([0.5, 0.5, 0. ]), normal=Vector([0., 0., 1.]))
+
+```
+
+## Transformation
+
+Transform multiple points to 1D coordinates along a line.
+
+```py
+>>> line = Line(point=[0, 0, 0], direction=[1, 2, 0])
+>>> points = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]
+
+>>> line.transform_points(points).round(3)
+array([ 2.236,  6.261, 10.286])
+
+```
+
+# Acknowledgment
+
+This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template.

scikit_spatial-8.0.0/pyproject.toml

@@ -0,0 +1,104 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "scikit-spatial"
+version = "8.0.0"
+description = "Spatial objects and computations based on NumPy arrays."
+
+license = { text = "BSD-3-Clause" }
+authors = [
+    { name = "Andrew Hynes", email = "andrewjhynes@gmail.com" },
+]
+
+readme = "README.md"
+keywords = ["NumPy", "matplotlib", "visualization", "spatial", "linear algebra"]
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: BSD License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering",
+]
+
+requires-python = ">=3.8"
+
+dependencies = [
+    "matplotlib>=3",
+    "numpy>=1.24",
+    "scipy>=1.9",
+]
+
+[project.urls]
+repository = "https://github.com/ajhynes7/scikit-spatial"
+documentation = "https://scikit-spatial.readthedocs.io"
+
+[tool.setuptools]
+packages = { find = { where = ["src"] } }
+
+[tool.uv]
+dev-dependencies = [
+    "pytest-cov>=5.0.0",
+    "pytest>=8.3.3",
+]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    # pydocstyle
+    "D",
+    # flake8-bugbear
+    "B",
+    # flake8-builtins
+    "A",
+    # flake8-commas
+    "COM",
+    # flake8-comprehensions
+    "C4",
+    # flake8-eradicate
+    "ERA",
+    # flake8-print
+    "T20",
+    # flake8-pytest-style
+    "PT",
+    # flake8-simplify
+    "SIM",
+    # flake8-unused-arguments
+    "ARG",
+    # isort
+    "I",
+    # pycodestyle
+    "E", "W",
+    # pyflakes
+    "F",
+    # NumPy 2 deprecation
+    "NPY201",
+]
+
+ignore = [
+    "D104",
+    "D105",
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["D"]
+"examples/*" = ["D"]
+"docs/*" = ["D"]
+
+[tool.ruff.format]
+quote-style = "preserve"

scikit_spatial-8.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+