Skip to content

Commit

Permalink
Updated Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
laxentis committed Nov 19, 2024
1 parent 618bc53 commit ecf6056
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,25 @@ This tool checks VATSIM METARs and preselects the runways for you.
## Configuration
The configuration file is located in `arse.json`. Edit it to your needs.

### Config preamble
`rwy_file` must point to the location of the `.rwy` file (corresponding to your sector file).
The following are optional configuration options:
* `no_factor_wind` - wind, below which the wind direction is ignored for runway assigment
* `pref_wind` - wind, below which the wind direction is ignored when preferred runway list is used
* `assumed_wind_dir` - wind direction that is assumed when it is unknown

### Airport config
`airports` is a list of all processed airports. It has the following required properties:
* `icao` - the ICAO code
* `runways` - a list of runways of the airport
* `runways` - a list of runways of the airport

The following optional properties can be set:
* `use_metar_from` - ICAO of an airport to get the METAR from. Useful for airports that do not have METARS available on VATSIM.
* `preferred_dep` - an ordered list of preferred departure runway ids
* `preferred_arr` - an ordered list of preferred arrival runway ids.
* `preferred_dep` - an ordered list of preferred departure runway ids,
* `preferred_arr` - an ordered list of preferred arrival runway ids,
* `no_factor_wind` - overrides `no_factor_wind` for given airport.

### Runway config
A `runway` consists of following properties:
* `id` - a string identifying a runway, must be the same as the runway ID in sector file (e.g. `"07L"`)
* `true_heading` - true heading of the runway, used to calculate wind angular difference

0 comments on commit ecf6056

Please sign in to comment.