The open source software to build cool stuff with locomotion
C++ Python CMake Shell PLpgSQL Mako
Latest commit 969525f Jan 20, 2017 @TeXitoi TeXitoi committed on GitHub Merge pull request #1937 from antoine-de/fix_crash_crash
Kraken: fix a crash on heat_map

readme.rst

navitia

(pronounce [navi-sia])

build status

Presentation

Welcome to the Navitia repository. Navitia is a service providing:

  1. multi-modal journeys computation
  2. line schedules
  3. next departures
  4. explore public transport data
  5. sexy things such as isochrones

The API can be found at http://api.navitia.io/

For more information see

Getting started

Want to test the API ?

The easiest way to do this is a to go to navitia.io. Signup, grab a token, read the doc and start using the API!

For a more friendly interface you can use the API through navitia playground

Want to use you own datasets or infrastructure ?

docker

The easiest way to do have your own navitia is to use the navitia docker-compose.

fabric

If you don't want to use the prebuild docker images you can use the fabric scripts we use to deploy to api.navitia.io.

WARNING: Those scripts should be usable, but they are not meant to be completly generics and are designed for own servers architecture.

Use this only if the docker is not fit for your needs and if you are an experienced user 😉

Want to dev in navitia ?

if you want to build navitia, please refer to the installation documentation

You can also check the automated build script which is meant as a step by step tutorial for compiling and using navitia with ubuntu 16.04

Code Organisation

At the root of the repository, several directories can be found:

  1. source: contains the navitia source code (c++ and python)
  2. third_party: third party developped modules
  3. documentation: all the navitia documentation
  4. (debug|release): by convention, the build repositories

Architecture overview

Navitia is made of 3 main modules:

  1. Kraken is the c++ core
  2. Jörmungandr is the python frontend
  3. Ed is the postgres database

Kraken and Jörmungandr communicate with each other through protocol buffer messages send by ZMQ.

Transportation data (in the GTFS format) or routing data (from OpenStreetMap for the moment) can be given to Ed. Ed produces a binary file used by Kraken.

documentation/diagrams/Navitia_simple_architecture.png

More information here: https://github.com/CanalTP/navitia/wiki/Architecture

Tools

  1. Gcc (or clang) as the C++ compiler (g++)
  2. Cmake for the build system
  3. Python for the api

How to contribute

Fork the github repo, create a new branch from dev, and submit your pull request!

Make sure to run the tests before submiting the pull request (make test in the build directory)

Are there many people contributing? Yes: https://www.youtube.com/watch?v=GOLfMTMGVFI

Alternatives?

Navitia is written in python/c++, here are some alternatives: