265
edits
Mickybadia (talk | contribs) mNo edit summary |
Mickybadia (talk | contribs) (v1.7.0) |
||
Line 1: | Line 1: | ||
{{forum|83|ATC-Pie support & development}} | {{forum|83|ATC-Pie support & development}} | ||
{{about| | {{about|installing and running ATC-pie|a manual on how to use it|ATC-pie user guide}} | ||
== Installing == | == Installing == | ||
=== Preparing === | |||
[[ATC-pie]] is free and open source, and programmed in Python3 for Qt5. It is therefore system-independant, but requires Python3 and the PyQt5 library to run. The exact dependencies and required versions are listed in the <code>README</code> file packed in the download. Once they are installed, it runs straight away without any compiling to do (make, etc.). | |||
=== Downloading === | === Downloading === | ||
There are essentially two ways of downloading | There are essentially two ways of downloading ATC-pie: one is to download a '''tarball''' to extract locally; the other is to clone the '''Git repository'''. | ||
Downloading the '''tarball''': | Downloading the '''tarball''': | ||
Line 14: | Line 17: | ||
To clone the Git '''repository''': | To clone the Git '''repository''': | ||
: <code>git clone git://git.code.sf.net/p/atc-pie/code ATC-pie</code> | : <code>git clone git://git.code.sf.net/p/atc-pie/code ATC-pie</code> | ||
=== More to install? === | === More to install? === | ||
The above alone will provide you with a working program, but | I say again: the above files are not enough, both Python3 and PyQt5 must be installed too. At this point, ''please'', read the <code>README</code> file for more notes on installation. | ||
* ''FlightGear'' for '''tower viewing''' in airport mode ( | |||
* the ''Python IRC library'' to enable the ATC '''full coorindation | The above alone will provide you with a working program, but further software pieces can be installed to enable extra features. Depending on how you mean to use ATC-pie, they can be recommended for more realism but they are not required, and can be installed later. These are: | ||
* ''FlightGear'' for '''tower viewing''' in airport mode, and of course the appropriate aircraft models and scenery data (note that it can be run on a separate machine, see [[ATC-pie user guide#Tower view window|feature note]] in the user guide); | |||
* the ''Python IRC library'' to enable the ATC '''full coorindation''' in FlightGear network sessions, incl. unlimited strip exchange and private text messaging; | |||
* ''PocketSphinx'' for '''voice instruction recognition''' in solo sessions; | * ''PocketSphinx'' for '''voice instruction recognition''' in solo sessions; | ||
* ''pyttsx'' for '''speech synthesis''' of pilot radio communications in solo sessions. | * ''pyttsx'' for '''speech synthesis''' of pilot radio communications in solo sessions. | ||
== Running == | == Running == | ||
Line 40: | Line 41: | ||
* The radar position field specifies the point on which to centre the radar. For example, <code>LFPO>090,15</code> will centre the radar on a point 15 NM to the East of Orly airport. Click on the help button for a summary of valid point specification formats, or read the ''Point specification'' section in the quick reference for more detail. | * The radar position field specifies the point on which to centre the radar. For example, <code>LFPO>090,15</code> will centre the radar on a point 15 NM to the East of Orly airport. Click on the help button for a summary of valid point specification formats, or read the ''Point specification'' section in the quick reference for more detail. | ||
You may | === Command line arguments === | ||
You may bypass the launcher and start directly at a given location with the following command, using an ICAO code for an airport or a previously defined CTR location code: | |||
: <code>./ATC-pie.py location_code</code> | : <code>./ATC-pie.py location_code</code> | ||
Besides, the following command line options are available: | |||
Besides | |||
{| class="wikitable" | {| class="wikitable" | ||
! Option || Effect and argument specification || Default | ! Option || Effect and argument specification || Default | ||
|- | |- | ||
| --map-range=''range'' || | | --map-range=''range'' || Only valid with a location code argument. Defines the distance in NM from the radar centre up to which the map will be drawn and navpoints listed in the navigator (accepted values are 20..500). || 100 in AD mode; 300 in CTR mode | ||
|- | |- | ||
| --views-send-from=''port'' || | | --views-send-from=''port'' || Sets the local UDP port number to bind for sending FGMS packets to views. This includes all tower and additional views, but does not affect the FGMS connection port, chosen on session start. || 5009 | ||
|} | |} | ||
Line 57: | Line 58: | ||
=== Initial configuration === | === Initial configuration === | ||
Things you will want to do when running ATC-pie for the first time. | Things you will want to do when running ATC-pie for the first time. | ||
* | * For network sessions ([[FGMS]] or FSD), give yourself a "social name" so that others recognise you when using any of the ATC coordination/exchange features. | ||
* | * To use the internal tower viewing system, make sure you have the right paths set for your [[FlightGear]] installation. | ||
* To use the integrated [[FGCom]] radio system (especially recommended in FlightGear network sessions), check the FGCom command entered in the system settings. If you have FlightGear installed on your machine, you can point to the FGCom executable already available with it. On Linux, the default "fgcom" command usually does the job. Otherwise, [https://sourceforge.net/projects/atc-pie/files/fgcom-standalone/ download an FGCom stand-alone program] from ATC-pie's SourceForge file list. To test your set-up, try an echo test from the ''System'' menu. If you have problems hearing yourself, search for "FGCom" in the [[ATC-pie FAQ]]. | |||
If you intend to operate often at a given location, it is sensible to: | |||
* download the latest airport data file from the [https://gateway.x-plane.com/airports/page# X-plane gateway] and place it in <code>CONFIG/ad</code> (see the <code>Notice</code> file there); | * download the latest airport data file from the [https://gateway.x-plane.com/airports/page# X-plane gateway] and place it in <code>CONFIG/ad</code> (see the <code>Notice</code> file there); | ||
* if | * review/fill the various fields in the location set-up dialog (a message pops up on the first time at a location, inviting you to open it), e.g. radar/communication equipment, and airport runway capabilities (necessary for more realisitc aircraft intentions in solo simulation); | ||
* | * build an elevation map, especially for solo and teacher sessions; | ||
* if using the radar, consider creating/importing background pictures (terrain maps, procedure charts...); | |||
* configure strip racks and bays to fit the environment and service provided, they will be saved for future runs; | |||
* pin your preferred navpoints so that they are restored on every run. | |||
For more detailed and advanced configuration, check the <code>CONFIG/Notice</code> | For more detailed and advanced configuration options, check the <code>CONFIG/Notice</code>. | ||
=== Starting sessions === | === Starting sessions === | ||
Solo simulation: | Solo simulation: | ||
* wind will be randomised at start, but will be forced to blow in a favourable direction if | * wind will be randomised at start, but will be forced to blow in a favourable direction if at least one active runway is selected before start; | ||
* traffic is spawned with intentions according to the ''solo simulation configuration options'' (<code>Shift</code>+<code>F11</code>), so it is preferable to configure them before starting the session to avoid undesired traffic at start. | * traffic is spawned with intentions according to the ''solo simulation configuration options'' (<code>Shift</code>+<code>F11</code>), so it is preferable to configure them before starting the session to avoid undesired traffic at start. | ||
FlightGear network session: | |||
* callsigns for ATCs in FlightGear are expected to start with the ICAO code of the controlled airport or sector, and end with a hint on the provided service (twr, gnd, ctr...), e.g. "KORDgnd" (note that FGMS restricts callsign length to 7 characters); | |||
* before choosing your callsign, make sure it is not already in use; | |||
* you can connect more than one ATC-pie instance from the same computer, but must use different ports. | |||
[[Category:ATC-pie]] | [[Category:ATC-pie]] |
edits