Welcome to pylocus, a python localization package

This package contains Multidimensional Scaling, lateration, and other algorithms useful for localization using distances and/or angles.

Local install

Since this package is in an early development phase, this is the recommended install method. The latest updates will not always be immediately available on pip, they will be bundled in the next package release. By keeping the local git repository up-to-date and redoing the local install regularly, you can be sure to be using the latest version.

To perform a local install on your computer, run from this folder level (where setup.py is located):

pip install -e . 

This installs the package using symbolic links, avoiding the need for a reinstall whenever the source code is changed. If you use conda, then

conda develop . 

does the same trick.

Install

To install from pip, simply run :

  pip install pylocus

Documentation

This is a constantly growing package and documentation is work-in-progress. The current version can be found on ReadTheDocs

See the tutorials folder for some exmaple scripts on how to use this package. More scripts will be added soon.