.. image:: documentation/diagrams/logo_navitia_horizontal_fd_gris_250px.png :alt: navitia :align: center

========= Navitia

(pronounce [navi-sia])

.. |Version Logo| image:: https://img.shields.io/github/v/tag/CanalTp/navitia?logo=github&style=flat-square :target: https://github.com/CanalTP/navitia/releases :alt: version

.. |Build Status| image:: https://img.shields.io/github/workflow/status/CanalTP/navitia/Build%20Navitia%20Packages%20For%20Release?logo=github&style=flat-square :target: https://github.com/CanalTP/navitia/actions?query=workflow%3A%22Build+Navitia+Packages+For+Release%22 :alt: Last build

.. |License| image:: https://img.shields.io/github/license/CanalTP/navitia?color=9873b9&style=flat-square :alt: license

.. |Chat| image:: https://img.shields.io/matrix/navitia:matrix.org?logo=riot&style=flat-square :target: https://app.element.io/#/room/#navitia:matrix.org :alt: chat

.. |Code Coverage| image:: https://codecov.io/gh/CanalTP/navitia/branch/dev/graph/badge.svg?token=hTcQmLu5t7 :target: https://codecov.io/gh/CanalTP/navitia/

+----------------+----------------+-----------+--------+-----------------+ | Version | Build status | License | Chat | Code Coverage | +----------------+----------------+-----------+--------+-----------------+ | |Version Logo| | |Build Status| | |License| | |Chat| | |Code Coverage| | +----------------+----------------+-----------+--------+-----------------+

Presentation

Welcome to the Navitia repository !

Navitia is a webservice providing:

#. multi-modal journeys computation

#. line schedules

#. next departures

#. exploration of public transport data

#. search & autocomplete on places

#. sexy things such as isochrones

Approach

| Navitia is an open-source web API, initially built to provide traveler information on urban transportation networks. | | Its main purpose is to provide day-to-day informations to travelers. | Over time, Navitia has been able to do way more, sometimes for technical and debuging purpose or because other functional needs fit quite well in what Navitia can do or just because it was quite easy and super cool. | | Technically, Navitia is a HATEOAS_ API that returns JSON formated results.

.. _HATEOAS: https://en.wikipedia.org/wiki/HATEOAS

Who's who

| Navitia is instanciated and exposed publicly through api.navitia.io_. | Developments on Navitia are lead by Kisio Digital (previously CanalTP). | Kisio Digital is a subsidiary of Keolis (itself a subsidiary of SNCF, French national railway company).

.. _api.navitia.io: https://api.navitia.io

More information

• main web site https://www.navitia.io
• playground https://canaltp.github.io/navitia-playground/
• integration documentation https://doc.navitia.io
• technical documentation https://github.com/CanalTP/navitia/tree/dev/documentation/rfc
• twitter @navitia https://twitter.com/navitia
• google groups navitia https://groups.google.com/d/forum/navitia
• channel #navitia on matrix/element https://app.element.io/#/room/#navitia:matrix.org

Getting started

Want to test the API ?

| The easiest way to do this is a to go to navitia.io <https://www.navitia.io/>. | Signup <https://www.navitia.io/register/>, grab a token, read the doc <https://doc.navitia.io>_ and start using the API!

For a more friendly interface you can use the API through navitia playground <https://canaltp.github.io/navitia-playground/>_ (no matter the server used).

Want to use you own datasets or infrastructure ?

docker

The easiest way to have your own navitia is to use the navitia
`docker-compose <https://github.com/CanalTP/navitia-docker-compose>`_.

fabric

| If you don't want to use the prebuilt docker images you can use the fabric scripts <https://github.com/CanalTP/fabric_navitia>_ we use to deploy to api.navitia.io. | ⚠️ WARNING ⚠️ Those scripts should be usable, but they are not meant to be completely generic and are designed for our own servers architecture. | Use this only if the docker does not suit your needs and if you are an experienced user 😉

Want to dev and contribute to navitia ?

If you want to build navitia, develop in it or read more about technical details please refer to CONTRIBUTING.md <https://github.com/canaltp/navitia/blob/dev/CONTRIBUTING.md>_.

Curious of who's contributing? ⏯ https://www.youtube.com/watch?v=GOLfMTMGVFI

Architecture overview

Navitia is made of 3 main modules:

#. Kraken is the c++ core (Heavy computation)

#. Jörmungandr is the python frontend (Webservice and lighter computation)

#. Ed is the postgres database (Used for preliminary binarization)

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

| Transportation data (in the NTFS <https://github.com/CanalTP/ntfs-specification/blob/master/readme.md>, or GTFS <https://developers.google.com/transit/gtfs/> format) or routing data (mainly from OpenStreetMap <https://www.openstreetmap.org/>_ for the moment) can be given to Ed. | Ed produces a binary file used by Kraken.

.. image:: documentation/diagrams/Navitia_simple_architecture.png

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

Alternatives?

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

• | OpenTripPlanner <https://github.com/opentripplanner/OpenTripPlanner/>_ : written in java. | More information here https://github.com/CanalTP/navitia/wiki/OpenTripPlanner-and-Navitia-comparison.
• rrrr <https://github.com/bliksemlabs/rrrr>_ : the lightest one, written in python/c
• Synthese <https://github.com/Open-Transport/synthese>_ : full stack, with CMS, written all in C++
• Mumoro <https://github.com/Tristramg/mumoro>_ : a R&D MUltiModal MUltiObjective ROuting algorithm