https://github.com/petja/ratakilometri.js

Find the shortest route between two railway stations of Finland by using Dijkstra's algorithm
https://github.com/petja/ratakilometri.js

javascript library nodejs open-data railroad railway

Last synced: about 1 month ago
JSON representation

Find the shortest route between two railway stations of Finland by using Dijkstra's algorithm

• Host: GitHub
• URL: https://github.com/petja/ratakilometri.js
• Owner: petja
• License: mit
• Created: 2018-05-07T16:52:10.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T20:17:22.000Z (about 2 years ago)
• Last Synced: 2024-12-23T03:51:20.096Z (about 1 month ago)
• Topics: javascript, library, nodejs, open-data, railroad, railway
• Language: JavaScript
• Homepage:
• Size: 906 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![ratakilometri.js](logo.png 'Ratakilometri.js')

[![Build Status](https://travis-ci.org/petja/ratakilometri.js.svg?branch=master)](https://travis-ci.org/petja/ratakilometri.js)

[![npm](https://img.shields.io/npm/v/ratakilometri.svg)](https://yarnpkg.com/en/package/ratakilometri)

[![license](https://img.shields.io/github/license/petja/ratakilometri.js.svg)](https://github.com/petja/ratakilometri.js/blob/master/LICENSE)

Find the shortest route between two railway stations of Finland by using Dijkstra's algorithm. Station location data the library is using, is extracted from the [PDF](https://julkaisut.liikennevirasto.fi/pdf8/lv_2018-01_luettelo_rautatieliikennepaikoista_web.pdf) provided by [Finnish Transport Agency](https://fta.fi/) and enriched with other information available freely on the Internet.

## Install

With Yarn:

```

yarn add ratakilometri

```

Or with NPM:

```

npm i -S ratakilometri

```

## Usage

```javascript

const { getRoute, getDistance } = require('ratakilometri')()

```

Or this way:

```javascript

import ratakm from 'ratakilometri'

const { getRoute, getDistance } = ratakm()

```

To find out distance or route:

```javascript

const route = getRoute('HL', 'KV')

const distance = getDistance('TUS', 'HKI')

console.log(route, distance)

```

## Options

As we pass parameters of `getRoute` almost directly to `node-dijkstra`, you can use [options object](https://github.com/albertorestifo/node-dijkstra#graphpathstart-goal--options) of the library as a third parameter of `getRoute`.

- `trim: boolean`, default `false`: If set to true, the result won't include the start and end stations.

- `reverse: boolean`, default `false`: If set to true, the route array will be in reversed order, from the end to start

- `avoid: array`, default `[]`: Stations to be avoided

---

:information_source: Be aware algorithm really tries to find out **the shortest path** which isn't always **the best path**. For example, if you try to find out distance from Leppävaara (LPV) to Tikkurila (TKL) for the commercial passenger train, library would tell you to go thru Ilmala Rail Yard (ILR) which surely isn't the best route :wink: