Skip to content

GitLab

Open
Created by Joseph Siddons@josiddOwner
Report abuse

Resolve "Improve documentation"

1 unresolved thread
Viewing commit bd0d5c29
Prev Next
8 files
+ 116
- 119
Show latest version
do‎cs‎
Document‎ation.tex‎ +111 -111
bisect‎ion.rst‎ +1 -1
inde‎x.rst‎ +1 -2
installa‎tion.rst‎ +1 -1
kdtre‎e.rst‎ +1 -1
octtr‎ee.rst‎ +1 -1
recor‎d.rst‎ +0 -1
shap‎e.rst‎ +0 -1
docs/Documentation.tex
+ 111
- 111

Files with large changes are collapsed by default.

docs/bisection.rst
+ 1
- 1
Show all unchanged lines Show 20 lines
from GeoSpatialTools import find_nearest
import numpy as np
search_values: list[float] = list(np.random.randn(50))
search_values.sort()
Show 20 lines Show all unchanged lines
docs/index.rst
+ 1
- 2
Show all unchanged lines Show 20 lines
.. toctree::
:maxdepth: 4
:caption: Contents:
introduction
installation
bisection
Show 20 lines Show all unchanged lines Show 20 lines
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`
docs/installation.rst
+ 1
- 1
Show all unchanged lines Show 20 lines
cd geospatialtools
# Install with all dependencies and create an environment with python 3.12
uv sync --all-extras --dev --python 3.12
uv sync --all-extras --dev --python 3.12
# Load the environment
source .venv/bin/activate
Show 20 lines Show all unchanged lines
docs/kdtree.rst
+ 1
- 1
Show all unchanged lines Show 20 lines
nearest neighbour. For :math:`k`-dimensional data (i.e. the data has :math:`k` features), a binary tree is constructed
by bisecting the data along each of the :math:`k` dimensions in sequence. The first layer bisects the data along the
first dimension, the second layer bisects each of the previous bisection results along the 2nd dimension (the data is
now partitioned into 4), and so on. The pattern repeats after the :math:`k`-th layer, until a single point of data
now partitioned into 4), and so on. The pattern repeats after the :math:`k`-th layer, until a single point of data
remains in each leaf node. A K-D-Tree that bisects data and results in each leaf node containing a single value is
called referred to as a balanced K-T-Tree.
Show 20 lines Show all unchanged lines
docs/octtree.rst
+ 1
- 1
Show all unchanged lines Show 20 lines
The ``OctTree`` class defined in ``GeoSpatialTools.octtree`` can be queried in the following ways:
* with a ``SpaceTimeRecord``, a spatial range, and a time range (specified by a ``datetime.timedelta``) with
* with a ``SpaceTimeRecord``, a spatial range, and a time range (specified by a ``datetime.timedelta``) with
``OctTree.nearby_points``. All points within the spatial range and time range of the ``SpaceTimeRecord`` will be
returned in a list.
* with a ``SpaceTimeRectangle`` using ``OctTree.query``. All points within the specified ``SpaceTimeRectangle`` will be returned in a list.
Show 20 lines Show all unchanged lines
docs/record.rst
+ 0
- 1
Show all unchanged lines Show 20 lines
.. automodule:: GeoSpatialTools.record
:members:
docs/shape.rst
+ 0
- 1
Show all unchanged lines Show 20 lines
.. automodule:: GeoSpatialTools.shape
:members: