Commit eb6865fc authored by Joseph Siddons's avatar Joseph Siddons
Browse files

docs: add docstrings for modules

parent 47b055e5
""" """
Distance Metrics
----------------
Functions for computing navigational information. Can be used to add Functions for computing navigational information. Can be used to add
navigational information to DataFrames. navigational information to DataFrames.
""" """
......
"""Class for a Great Circle object.""" """
GreatCircle
-----------
Constructors and methods for interacting with GreatCircle objects, including
comparisons between GreatCircle objects.
"""
import numpy as np import numpy as np
......
""" """
KDTree
------
An implementation of KDTree using Haversine Distance for GeoSpatial analysis. An implementation of KDTree using Haversine Distance for GeoSpatial analysis.
Useful tool for quickly searching for nearest neighbours. Useful tool for quickly searching for nearest neighbours. The implementation is
a K=2 or 2DTree as only 2 dimensions (longitude and latitude) are used.
Haversine distances are used for comparisons, so that the spherical geometry
of the earth is accounted for.
""" """
from . import Record from . import Record
......
"""Functions for finding nearest neighbours using bisection.""" """
Neighbours
----------
Functions for finding nearest neighbours using bisection.
"""
from numpy import argmin from numpy import argmin
from bisect import bisect from bisect import bisect
......
"""
OctTree
-------
Constuctors for OctTree classes that can decrease the number of comparisons
for detecting nearby records for example. This is an implementation that uses
Haversine distances for comparisons between records for identification of
neighbours.
"""
from dataclasses import dataclass from dataclasses import dataclass
from typing import List, Optional from typing import List, Optional
import datetime import datetime
......
""" """
QuadTree
--------
Constuctors for QuadTree classes that can decrease the number of comparisons Constuctors for QuadTree classes that can decrease the number of comparisons
for detecting nearby records for example for detecting nearby records for example. This is an implementation that uses
Haversine distances for comparisons between records for identification of
neighbours.
""" """
from dataclasses import dataclass from dataclasses import dataclass
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment