Trajectory Mining Library

Trajectory mining library inspired by and based on scikit-learn.

Installation

To install trajminer using pip, run:

pip install trajminer

Trajminer requires Python 3.6.5 or greater, plus the following packages:

• joblib >= 0.13.0
• numpy >= 1.15.3
• scikit-learn >= 0.19.1
• keras >= 2.2.4
• geohash2 >= 1.1
• pandas >= 0.24.1

Documentation

The documentation of the latest version, as well as of past versions, can be found here.

Contribute

Everyone is welcome to contribute to the project, either by fixing open issues or suggesting new features and reporting bugs (be sure your issue isn't already reported or even fixed).

Important Links

• Issue tracker
• Releases
• Official wepbage

Testing

pytest trajminer

Checking Code Style (PEP8)

bash check_code_style.sh

Building the Docs

Inside the doc folder, run:

bash build.sh [target-folder]

Some Guidelines

Before submitting a pull request:

• Please check if your code follows the PEP8 style guide. You may do so by running flake8.
• Make sure you added the proper documentation (if adding new features) or corrected the existing one (if making changes to existing code). Also, ensure that you can build the docs.
• Please ensure that all tests are passing.

Citation in Scientific Works

If you use this library in any scientific work, please cite it as follows:

@misc{petry2019trajminer,
  title={Trajminer},
  author={Petry, Lucas May and others},
  year={2019},
  howpublished={\url{https://trajminer.github.io}},
}