GeosPy is a MIT Licensed Geolocation Inference Library, written in Python.
Of the few existing Python modules for conducting geolocation inference, most are verbose and cumbersome.
>>> from GeosPy import Geos
>>> geosPy = Geos()
>>> print(geosPy.models)
frozenset({'jakartr', 'backstrom'})
>>> geosPy = geosPy.set_model('backstrom')
>>> user_location_dict = {
... 'Tyler': (44, -71.5), 'Tim': (45.5, -73.5), 'Gwyn': (44.5, -89.5),
... 'Conor':(55.0, -106.0), 'Sam': (25.7, -80.2), 'OffTheGrid': None}
>>> user_friend_dict = {'OffTheGrid': ['Tyler', 'Sam', 'Gwyn', 'Conor', 'Tim']}
>>> print(geosPy.locate(user_location_dict, user_friend_dict))
{'Conor': (55.0, -106.0), 'Sam': (25.7, -80.2), 'Tyler': (44, -71.5),
'Gwyn': (44.5, -89.5), 'Tim': (45.5, -73.5), 'OffTheGrid': (45.5, -73.5)}
...GeosPy is based off of Jurgens et al. (2015), implementing state-of-the-art methods for geolocation inference. It allows the user to locate nodes with unknown locations based solely on network-based relationships.
Geolocation inference is the identification of the real-world geographic location of an object on Earth based off of available data. GeosPy currently only supports network based inference methods.
- State-of-the-art geolocation inference method(s)
- Supports python 3.3, 3.4 and 3.5
- Written in cython
- Test coverage
To install GeosPy from source run the following commands
> git clone https://github.com/tylfin/GeosPy/
> cd GeosPy
> pip install -r requirements.txt
...
Successfully installed ...
> make build_inplace
...
> make test
...
OK
> make install
...PIP support coming soon!
GeosPy documentation is provided in the form of Jupyter notebooks.
For a basic usage example, checkout the introduction.
Directory Structure:
├── GeosPy
│ ├── __init__.py
│ ├── geos.pyx
│ ├── models
│ │ ├── __init__.py
│ │ ├── backstrom.pyx
│ │ └── jakartr.pyx
│ └── utilities
│ ├── __init__.py
│ └── distance.pyx
├── docs
│ ├── intro.ipynb
│ └── trainModels.ipynb
├── setup.py
└── tests
├── __init__.py
├── test_backstrom.py
├── test_geos.py
└── test_utilities.py
- Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
- Fork the repository on GitHub to start making your changes to the master branch (or branch off of it).
- Write a test which shows that the bug was fixed or that the feature works as expected.
- Send a pull request and bug the maintainer until it gets merged and published. Make sure to add yourself to AUTHORS.