Skip to content

Latest commit

 

History

History
39 lines (32 loc) · 3.05 KB

README.md

File metadata and controls

39 lines (32 loc) · 3.05 KB

agine
GitHub license GitHub issues PyPI Package

agine is a Python package which have functionalities related to points in an n-dimensional space (which is defined by its x, y, ...z coordinates), or an actual position on the Earth (given by its latitude, longitude). Considering two points (say P, Q), apart from many other purposes, this library can also detect if the two have a clear line of sight or not.

Basic Usage

agine has three main functionalities: (1) Calculation of Distances, using different metrics, which is defined under commons, (2) Functions to Find the Nearest Neighbor and (3) Function to Find if two Geographic Point has a Line-of-Sight or not. All of this can be done using the following:

pip install agine

# or if you want to build from source
git clone https://github.com/ZenithClown/agine.git

If you want to install agine in editable mode:

pip install -e agine # Installing agine with pip
import agine
>> Setting up agine-Environment...
>>   Detected OS            : "<os-name-with-version>"
>>   scikit-learn Options   : "<is-scikit-learn-available>"
>>   "etc. which Defines the Core-Capability"

agine has a hard dependency of only numpy so that some of its functionalities can be used somewhere else. For options (2) and (3) it has different requirements, which can be accessed using: agine.OSOptions._point_func and agine.OSOptions._line_of_st repectively.