Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hiposfer/kamal
A routing engine service using Open Street Maps and GTFS as data source
https://github.com/hiposfer/kamal
clojure dijkstra gtfs osm routing transit
Last synced: about 2 months ago
JSON representation
A routing engine service using Open Street Maps and GTFS as data source
- Host: GitHub
- URL: https://github.com/hiposfer/kamal
- Owner: hiposfer
- License: lgpl-3.0
- Archived: true
- Created: 2017-06-15T13:10:51.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-06-21T17:40:48.000Z (over 5 years ago)
- Last Synced: 2024-07-04T22:42:26.542Z (3 months ago)
- Topics: clojure, dijkstra, gtfs, osm, routing, transit
- Language: Clojure
- Homepage:
- Size: 1.09 MB
- Stars: 11
- Watchers: 4
- Forks: 1
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kamal [](https://travis-ci.org/hiposfer/kamal) [](https://clojars.org/hiposfer/kamal)
A routing engine and API service based on Open data. Its current focus are flexibility,
speed and stability in that order.
## Usage
Check out the [API examples](resources/kamal.postman_collection.json) provided as a [Postman](getpostman.com) collection.
Simply import it and have fun :)
For a demo see [try.hyposfer.com](http://try.hiposfer.com/index.html)
(it will take a few seconds on the first run).
By default `kamal` will run at [localhost:3000](http://localhost:3000).
## Installation
You can install `kamal` from _clojars_ using _lein_ or use our _docker_ image.
### Leiningen
```
$ git clone https://github.com/hiposfer/kamal.git && cd kamal
## set up environment variables
$ export FRANKFURT_AREA_NAME="Frankfurt am Main"
$ export FRANKFURT_AREA_GTFS=resources/test/frankfurt.gtfs.zip
## preprocess input data -> output to ./resources/test
$ lein run -m hiposfer.kamal.preprocessor
## compile application - you can run it with lein as well
$ lein with-profile release uberjar
export FRANKFURT_AREA_EDN resources/test/frankfurt.edn.gz
$ java -jar target/kamal.jar
```
### Docker
Use our latest docker image:
$ ## setup env vars like above and pass them to docker
$ docker run -it -p 3000:3000 hiposfer/kamal
## Development
We follow [Stuart Sierra's reload workflow](https://github.com/stuartsierra/component).
Our system configuration is created by reading the environment variables. An example
of such config can be found in `hiposfer.kamal.dev/env`. As you can see there, it is
also possible to create a system by providing the configuration directly.
1. Start a REPL
2. Load the `hiposfer.kamal.dev` namespace
3. Run the `hiposfer.kamal.dev/refresh!` function
4. Perform your changes
- if your changes modify the network build process. Repeat from `3.`
- keep making your changes in the repl otherwise
In other words:
```
$ git clone https://github.com/hiposfer/kamal.git && cd kamal
$ lein repl
hiposfer.kamal.core=> (use 'hiposfer.kamal.dev)
hiposfer.kamal.core=> (hiposfer.kamal.dev/refresh!)
```
And then browse to [localhost:3000](http://localhost:3000)
## OSM Files
`kamal` consumes General Transit Feed Specification (GTFS) and Open Street Map files.
`kamal` is very routing oriented, thus we rely on the awesome Overpass-API for
filtering of Open Street Map data. Check out our `pedestrian` filtering query
[Here](resources/osm/overpass-api-query.txt).
You can customize it however you want; once you are done, simply save the query run the
preprocessing script again with `lein preprocess resources/`. This will preprocess
all gtfs configs in your environment variables with (automatically) downloaded osm data.
## License
`kamal` is distributed under LGPL v3