pymeos 0.0.8

Python bindings to MEOS

MEOS (Mobility Engine, Open Source) is a C++ library which makes it easy to work with temporal and spatio-temporal data. It is based on MobilityDB's data types and functions. MEOS's code is heavily inspired from a similar library called GEOS - hence the name. This repository also includes PyMEOS - python bindings to MEOS using pybind11.

⚠️ Currently this library is an early, experimental stage - breaking changes might occur as it evolves.

Usage

Python

Installation

$ pip install git+https://github.com/adonmo/meos

Note: This assumes libgeos-dev is already installed on your system.

Code sample

import datetime
from pymeos import Geometry
from pymeos.temporal import TInstantGeom, TSequenceGeom


def datetime_utc(year, month, day, hour=0, minute=0, second=0):
    return datetime.datetime(year, month, day, hour, minute, second, tzinfo=datetime.timezone.utc)


# Example creation of trajectory (temporal sequence of geometries)
trajectory = TSequenceGeom({
    TInstantGeom(Geometry(0, 0), datetime_utc(2012, 1, 1, 8, 0)),
    TInstantGeom(Geometry(2, 0), datetime_utc(2012, 1, 1, 8, 10)),
    TInstantGeom(Geometry(2, 1), datetime_utc(2012, 1, 1, 8, 15)),
})

print(trajectory)

[POINT (0 0)@2012-01-01T08:00:00+0000, POINT (2 0)@2012-01-01T08:10:00+0000, POINT (2 1)@2012-01-01T08:15:00+0000)

Documentation

Docs and API Reference: https://pymeos.netlify.app

More detailed usage guide/quickstart: https://pymeos.netlify.app/quickstart.html

C++

#include <iostream>
#include <meos/types/temporal/TSequence.hpp>
#include "time_utils.cpp"
using namespace std;


int main() {
    set<TInstant<int>> instants = {
        TInstant<int>(2, unix_time_point(2012, 1, 1)),
        TInstant<int>(1, unix_time_point(2012, 1, 2)),
        TInstant<int>(4, unix_time_point(2012, 1, 3)),
        TInstant<int>(3, unix_time_point(2012, 1, 4)),
    };
    TSequence<int> tseq(instants);
    cout << tseq << endl;
    return 0;
}

Example

Minimalistic C++ app example: https://github.com/adonmo/meos-cpp-example

Documentation

C++ API Reference: https://meos.netlify.app

Development

MEOS uses the CMake and setuptools for the build system, and Catch2 and pytest for tests.

Building

$ cmake -B build -S .
$ cmake --build build

Testing

C++

$ cmake -B build/test -S test -DCMAKE_BUILD_TYPE=Release
$ cmake --build build/test --config Release
$ ./build/test/libmeos-tests

Python

$ pip install .
$ pip install -r tests/python/requirements.txt
$ pytest

Building docs

C++ (Doxygen)

$ cmake -B build/docs -S documentation
$ cmake --build build/docs
$ cmake --build build/docs --target cppdocs

You can then proceed to host the docs locally, for example on http://0.0.0.0:8000/

$ python -m http.server --directory build/docs/doxygen/html

Python (Sphinx)

$ pip install .[docs]
$ cmake -B build/docs -S documentation
$ cmake --build build/docs
$ cmake --build build/docs --target pydocs

You can then proceed to host the docs locally, for example on http://0.0.0.0:8000/

$ python -m http.server --directory documentation/python/_build/html

Contributing

Issues and pull requests are welcome.

• For proposing new features/improvements or reporting bugs, create an issue.
• Check open issues for viewing existing ideas, verify if it is already proposed/being worked upon.
• When implementing new features make sure to add relevant tests and documentation before sending pull requests.