Skip to content

Commit

Permalink
Fix broken links.
Browse files Browse the repository at this point in the history
  • Loading branch information
elliotwutingfeng committed Sep 7, 2024
1 parent 603884f commit bc9c4db
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/COMMANDS.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Four arguments are required:

- `--start`: Origin station code. Example: **NS14**.
- `--end`: Destination station code. Example: **TE29**.
- `--coordinates-file`: Path to CSV file with location coordinates for every station. Example: [station_coordinates.csv](config_examples/station_coordinates.csv)
- `--network-file`: Path to network config file with rail network [graph](https://en.wikipedia.org/wiki/Graph_theory) node and edge details. Example: [network_tel_4.toml](config_examples/network_tel_4.toml)
- `--coordinates-file`: Path to CSV file with location coordinates for every station. Example: [station_coordinates.csv](/config_examples/station_coordinates.csv)
- `--network-file`: Path to network config file with rail network [graph](https://en.wikipedia.org/wiki/Graph_theory) node and edge details. Example: [network_tel_4.toml](/config_examples/network_tel_4.toml)

```bash
poetry run python railrailrail/cli.py route --coordinates-file config/station_coordinates.csv --network-file config/network_tel_4.toml --start NS14 --end TE29
Expand Down
4 changes: 2 additions & 2 deletions docs/CONFIG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ There are 2 types of config files:

## Station Coordinates

[station_coordinates.csv](config_examples/station_coordinates.csv) maps stations to their latitude and longitude in decimal degrees. This includes both future and defunct stations.
[station_coordinates.csv](/config_examples/station_coordinates.csv) maps stations to their latitude and longitude in decimal degrees. This includes both future and defunct stations.

## Network Config

Each network config file contains rail network [graph](https://en.wikipedia.org/wiki/Graph_theory) node and edge details for a given stage, stored in the [TOML](https://toml.io) format. For example, [network_nel.toml](config_examples/network_nel.toml) represents the rail network as of 20 June 2003, when the North East Line opened.
Each network config file contains rail network [graph](https://en.wikipedia.org/wiki/Graph_theory) node and edge details for a given stage, stored in the [TOML](https://toml.io) format. For example, [network_nel.toml](/config_examples/network_nel.toml) represents the rail network as of 20 June 2003, when the North East Line opened.

> [!TIP]
> For `[segments]`, `[transfers]`, and `[conditional_transfers]`, you can change any of the time durations (`duration`, `dwell_time_asc`, `dwell_time_desc`) to values in the range 0-3600 seconds inclusive.
Expand Down

0 comments on commit bc9c4db

Please sign in to comment.