diff --git a/docs/contribute/sectorfiles/.pages b/docs/contribute/sectorfiles/.pages deleted file mode 100644 index 99f27098..00000000 --- a/docs/contribute/sectorfiles/.pages +++ /dev/null @@ -1,10 +0,0 @@ -# Edit this page to get: -# - Title for the whole directory -# - Titles for specific pages or subdirectories -# - Order of pages (otherwise alphabetical order) - -title: Sector Files -nav: - - Overview: index.md - - setup.md - - ... \ No newline at end of file diff --git a/docs/contribute/sectorfiles/InterfaceOverview.md b/docs/contribute/sectorfiles/InterfaceOverview.md deleted file mode 100644 index a8cdce7a..00000000 --- a/docs/contribute/sectorfiles/InterfaceOverview.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: Interface Overview ---- - ---8<-- "includes/abbreviations.md" - -This section will run through the buttons on each interface screen, and link to the respective page within the SFG guide. - -
- ![SFG Main Screen](assets/mainScreen.png){ width="350"} -
Main Screen
-
- -### Export Tab - -* `AIRAC Version` allows you to set the current version being worked on. This also dictates the name of the current working directory in the `AIRAC Testing` folder. - -* `Euroscope Effective Date` will automatically populate depending on the AIRAC version. This is automatically appended in the EuroScope disclaimer, and [INFO] output. This can be manually edited for a rush revision. - -* ++"Write Master .ese"++ exports the master `.ese` file to the current working directory. - -* ++"User Options"++ allows you to change various configuration options, such as the `ControllerInfo` text, MySQL access config and the Holding Pattern draw config. - -* ++"Update eAIP Document URLs"++ allows you to define the web locations of the PDF files on the ANR website. ++"Update eAIP Import Filters"++ allows you to edit the import regex filters. - -* ++"Export vatSys"++ and ++"Export Euroscope"++ do exactly that - export the NZZC and Pacific datasets to the current working directory. - -### Check Data Tab - -
- ![Data Check Tab](assets/dataCheckScreen.png){ width="350" } -
Data Check Tab
-
- -* ++"Check SID/STAR Names"++ checks all of the procedures in the database against the AIP-supplied Part 95 Procedure sheets. The "Supported Categories" tickboxes dictate what category of procedures are checked - [more information](datamanagement/procedurecheck.md) - -### DB Update Tab - -
- ![Database Screen](assets/dbScreen.png){ align=right width="350"} -
Database Screen
-
- - -* ++"Procedure Editor"++ opens the Procedure Editor screen - [more information](DataManagement/ProcedureEditor.md){ target=blank } - -* ++"Extract and Import all eAIP Data"++ downloads and import the latest ANR data - [more information](DataManagement/ImportingANRData.md){ target=blank } - -* `eAIP Manual Import` section contains various methods for manual data entry - [more information](DataManagement/ImportingANRData.md){ target=blank } - -* ++"Import ESE"++ imports the master .ese file, which is used for the POF table, amongst other uses - [more information](DataManagement/MasterESE.md){ target=blank } - -* ++"Import Manual IFR Fix"++ allows you to import missing NZZC fixes, such as procedural waypoints for RNP procedures. - -* ++"Import Arpt Layout File"++ allows for the importing of aerodrome ground layouts for export to both vatSys and ES. - -* ++"Import Pacific Data"++ updates the Pacific airspace data in the database - [more information](DataManagement/ImportingANRData.md){ target=blank } - -* ++"Airspace Converter"++ is a manual conversion utility, allowing for the conversion between eAIP draw definitions and other formats. - -### Utilities Tab - -
- ![Utilities Screen](assets/UtilitiesScreen.png){ width="350"} -
Utilities Screen
-
- -* ++"Convert PDF to Text"++ allows for the manual conversion of ANR files from PDF to text. - -* ++"IFR and VFR Plan G Fixes"++ exports all IFR and VFR fixes into a CSV format - [more information](LNMVFRFixes/){ target=blank } - -* ++"Update Airport Magnetic Variation"++ updates all aerodrome magnetic variations. This should be done once a year. - -* ++"APT .kml Layout to ISO/SCT"++ converts a .kml layout from Google Earth into the necessary EuroScope and vatSys files - [more information](ADLayouts/){ target=blank } - -* The four VATSpy buttons are explained in the [VATSpy section](VATSpy/){ target=blank } of the documentation. - -* The various coastline functions are [explained here](DataManagement/UpdatingCoastlines.md){ target=blank }. - -### DMS Conversion - -
- ![Conversions Screen](assets/DMSConvScreen.png){ width="350"} -
Conversions Screen
-
- - -This tab allows for the conversion between SCT/eAIP/Decimal and ISO coordinate formats. - -This tab also allows for the conversion between RGB values, and the weird format that EuroScope uses. - diff --git a/docs/contribute/sectorfiles/assets/DMSConvScreen.png b/docs/contribute/sectorfiles/assets/DMSConvScreen.png deleted file mode 100644 index 2332e1d0..00000000 Binary files a/docs/contribute/sectorfiles/assets/DMSConvScreen.png and /dev/null differ diff --git a/docs/contribute/sectorfiles/assets/Echo5.png b/docs/contribute/sectorfiles/assets/Echo5.png deleted file mode 100644 index baf65955..00000000 Binary files a/docs/contribute/sectorfiles/assets/Echo5.png and /dev/null differ diff --git a/docs/contribute/sectorfiles/assets/NewApproach.png b/docs/contribute/sectorfiles/assets/NewApproach.png deleted file mode 100644 index a8ab4a32..00000000 Binary files a/docs/contribute/sectorfiles/assets/NewApproach.png and /dev/null differ diff --git a/docs/contribute/sectorfiles/assets/NewSID.png b/docs/contribute/sectorfiles/assets/NewSID.png deleted file mode 100644 index 0f9573da..00000000 Binary files a/docs/contribute/sectorfiles/assets/NewSID.png and /dev/null differ diff --git a/docs/contribute/sectorfiles/assets/PopulatedApproach.png b/docs/contribute/sectorfiles/assets/PopulatedApproach.png deleted file mode 100644 index 7257ceaf..00000000 Binary files a/docs/contribute/sectorfiles/assets/PopulatedApproach.png and /dev/null differ diff --git a/docs/contribute/sectorfiles/assets/PopulatedSID.png b/docs/contribute/sectorfiles/assets/PopulatedSID.png deleted file mode 100644 index 9d5630f6..00000000 Binary files a/docs/contribute/sectorfiles/assets/PopulatedSID.png and /dev/null differ diff --git a/docs/contribute/sectorfiles/assets/PopulatedSTAR.png b/docs/contribute/sectorfiles/assets/PopulatedSTAR.png deleted file mode 100644 index 22192d8f..00000000 Binary files a/docs/contribute/sectorfiles/assets/PopulatedSTAR.png and /dev/null differ diff --git a/docs/contribute/sectorfiles/assets/ProcEdMainScreen.png b/docs/contribute/sectorfiles/assets/ProcEdMainScreen.png deleted file mode 100644 index 26b03557..00000000 Binary files a/docs/contribute/sectorfiles/assets/ProcEdMainScreen.png and /dev/null differ diff --git a/docs/contribute/sectorfiles/assets/SIDScreen.png b/docs/contribute/sectorfiles/assets/SIDScreen.png deleted file mode 100644 index d595ff23..00000000 Binary files a/docs/contribute/sectorfiles/assets/SIDScreen.png and /dev/null differ diff --git a/docs/contribute/sectorfiles/assets/UtilitiesScreen.png b/docs/contribute/sectorfiles/assets/UtilitiesScreen.png deleted file mode 100644 index 24fb3e2b..00000000 Binary files a/docs/contribute/sectorfiles/assets/UtilitiesScreen.png and /dev/null differ diff --git a/docs/contribute/sectorfiles/assets/dataCheckScreen.png b/docs/contribute/sectorfiles/assets/dataCheckScreen.png deleted file mode 100644 index bd13c7b8..00000000 Binary files a/docs/contribute/sectorfiles/assets/dataCheckScreen.png and /dev/null differ diff --git a/docs/contribute/sectorfiles/assets/dbScreen.png b/docs/contribute/sectorfiles/assets/dbScreen.png deleted file mode 100644 index 9e4ce459..00000000 Binary files a/docs/contribute/sectorfiles/assets/dbScreen.png and /dev/null differ diff --git a/docs/contribute/sectorfiles/assets/mainScreen.png b/docs/contribute/sectorfiles/assets/mainScreen.png deleted file mode 100644 index 7dca2252..00000000 Binary files a/docs/contribute/sectorfiles/assets/mainScreen.png and /dev/null differ diff --git a/docs/contribute/sectorfiles/datamanagement/.pages b/docs/contribute/sectorfiles/datamanagement/.pages deleted file mode 100644 index 84f38a1b..00000000 --- a/docs/contribute/sectorfiles/datamanagement/.pages +++ /dev/null @@ -1,8 +0,0 @@ -# Edit this page to get: -# - Title for the whole directory -# - Titles for specific pages or subdirectories -# - Order of pages (otherwise alphabetical order) - -title: Data Management -nav: - - ... \ No newline at end of file diff --git a/docs/contribute/sectorfiles/datamanagement/DatabaseTables.md b/docs/contribute/sectorfiles/datamanagement/DatabaseTables.md deleted file mode 100644 index e2176071..00000000 --- a/docs/contribute/sectorfiles/datamanagement/DatabaseTables.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -title: Database Tables ---- - ---8<-- "includes/abbreviations.md" - -This section will outline some of the tables within the database, and what they are used for. - -### airspace - -All discreet portions of defined airspace are found in this table. These are only airspace definitions and not boundary definitions - those can be found in the `airspaceboundary` table. - -More information on this table can be found on the [Manual Airspace Definitions](ManualDefinitions.md) page. - -### airspaceboundary - -Contains the boundary points for the airspace defined in the `airspace` table. The value in the `id_airspace` column aligns with the `id` for a particular piece of airspace in the `airspace` table. - -This table is edited through the import process, and you should not edit this table. - -### airwaywpts - -Contains the defined segments of an airway. The value in the `aw_id` column aligns with the `id` for a particular airway in the `airwayxml` table. - -This table is edited through the import process, and you should not edit this table. - -### airwayxml - -Contains the defined airways. The `Route` is the name of the airway. - -This table is edited through the import process, and you should not edit this table. - -### ap_aids - -Contains all of the discrete points in space within the dataset. They are defined by the `Type` column: - - * **AD, HP** - Aerodromes or Heliports. - * **IFR_FIX** - All IFR fixes, either though manual or automatic import. - * **THR_FIX** - Fixes that exist at the threshold of a runway. These are automatically appended to all approaches when exported. - * **VFR_FIX** - Visual Reporting Points. - * **NDB, VOR** - NDBs and VORs. Also has an associated two or three letter identifier, a frequency and a full name. - * **PAC_FIX** - All IFR fixes that exist within the NZZO/NTTT/TSN boundaries. - * **PAC_NDB and PAC_VOR** - All NDBs and VORs that exist within the NZZO/NTTT/TSN boundaries. - * **PAC_AIRPORT** - All airports that exist within the NZZO/NTTT/TSN boundaries, but outside of the NZZC. - -This table is edited through the import process, and you should not edit this table. - -### artcclookup - -This table defines how specific airspace types get treated during the EuroScope export. - -This table is edited through the import process, and you should not edit this table. - -### colours - -This table contains all of the colour definitions that are exported as a part of the EuroScope export. - -Values in the `ColourCode` column should conform to the standard EuroScope colour schema. - -### contl_apt - -This table defines all of the aerodromes that are Controlled. This includes all stations - GND through to APP. - -### diagrams - -### disclaimer - -The disclaimer that is exported as a part of the EuroScope export. - -### disclaimer_test - -The disclaimer that is exported as a part of the EuroScope export when testing is enabled. - -### es_arpt_layouts - -Contains the layouts that are imported through `DB Update > Import Arpt Layout File`. This is exported during the EuroScope export. - -### es_copx - -Contains all COPX definitions for EuroScope. This is exported in both the vatSys and EuroScope exports and can be amended through the Master ESE. - -### es_freetext - -Contains all free text definitions. This is exported in both the vatSys and EuroScope exports and can be amended through the Master ESE. - -### es_radar - -Contains all RADARs for both vatSys and EuroScope. This is exported in both the vatSys and EuroScope exports and can be amended through the Master ESE. - -### es_sectorline - -Contains the SCL definitions used for EuroScope. This is exported in the EuroScope export and can be amended through the Master ESE. - -### es_sectors - -Contains all discrete sector/volume owners for EuroScope. This is exported in the EuroScope export and can be amended through the Master ESE. - -### geo - -### geo_coast - -Contains the coastline data for both EuroScope and vatSys. [See the Updating Coastlines page](UpdatingCoastlines.md) for how to update this. - -### holding - -Contains all defined holds. This table is edited through the import process, and you should not edit this table. - -### info - -Contains the [INFO] section that is exported as a part of the EuroScope export. - -### labels - -### magvar - -Contains the Magnetic Variation for each aerodrome within the dataset. This should be updated once a year though `Utilities > Update Airport Magnetic Variation`. - -### pac_airwaywpts - -Much like the `airwaywpts` table, but for Pacific Airways. - -### pac_airwayxml - -Much like the `airwayxml` table, but for Pacific Airways. - -### proc_name_abbrv - -For procedures that have a different full name, when compared to what is shown in the aircraft FMC. For example, the `November 1` departure is shown as the `NVBR1` on aerodrome plates. - -The data in the `sct_name` column defines the full name of the procedure, and `ese_name` is the abbreviated name for the procedure. This is usually shown on the aircraft plate in brackets. - -Normal IFR Point termination procedures such as the `NOBAR1E` will automatically be shortened to the `NOBA1E`, so there is no need to put these in. - -You can use the shortened name within the name of a procedure within the Procedure Editor, and it will automatically resolve back to the full name. - -### procedures - -Contains all procedures as defined in the Procedure Editor. - -You should not edit this table unless the SFG tells you to, as a part of its' error checking. - -### ra_nameabbrv - -Contains VRP point abbreviations. Where a word in a VRP matches with the text column, it is abbreviated to the matched text. - -### regions - -### runway - -Contains all defined runways for both datasets, and each runway had its own entry. - -This table also allows you to set the extended centreline that is shown within the `Runways` map in vatSys. `RwyXExt` defines the distance the extended centreline is drawn, and `TickXInt` defines how often a mile marker is drawn. - -### transfixes - -Defines all transition fixes. This table is automatically generated by the SFG, and should not be edited unless the SFG tells you to as a part of its' error checking. - -### uncontl_apt - -By default, the SFG will not export distinct map layers for all aerodromes, unless they are defined as a controlled aerodrome in the `contrl_apt` table. - -Since many aerodromes in the NZZC have IFR procedures, they can be added to this table to have their various ACU map layers drawn on export. \ No newline at end of file diff --git a/docs/contribute/sectorfiles/datamanagement/ManualDefinitions.md b/docs/contribute/sectorfiles/datamanagement/ManualDefinitions.md deleted file mode 100644 index e3eef967..00000000 --- a/docs/contribute/sectorfiles/datamanagement/ManualDefinitions.md +++ /dev/null @@ -1,233 +0,0 @@ ---- - title: Manual Airspace Definitions ---- - ---8<-- "includes/abbreviations.md" - -The Sector File Generator, in addition to automatically importing CTR/CTA/OCA airspace definitions, can also store and export manual airspace definitions. This is incredibly handy for having different Enroute Sectors export definitions for vatSpy versus vatSys, for example. - -## Database Overview - -Draw definitions follow the standard NZ eAIP method of drawing airspace, as used in the ANR. - -All airspace definitions are stored in the `airspace` table of the database. The important columns are - - -* `id` - Automatically generated on import. -* `ident` - The identifier of that airspace. This is explained below. -* `VSName`, `Comment` - Contains the name of the airspace. -* `Type` - Airspace Type. This is explained below. -* `ExportID` - Dictates which product this airspace is exported to. This is explained below. - -### Unique Airspace Identifiers - -All airspace imported into the database must have a unique `ident`. Airspace imported from the ANR will have their airspace designator set as the `ident`, so should be unique by default. - -It is best practice to have the Sector set as the `ident`, as it is easily distinguishable, without having to manually test it. Imported airspace identifiers **must** fit the following criteria - - -* **Enroute**: `NXXX`, with an optional `_X` or `-X` where X can be alphanumeric. -* **Manual FIR**: `NXXX`, with an optional `_X` or `-X` where X can be alphanumeric. -* **TMA**: `NZTnnn`, with an optional `_X` or `-X` where X can be alphanumeric. - * where `nnn` is a unique sequence number. - -### Airspace Types - -There are a handful of different airspace types in the database. The `CFZ`, `MBZ`, `CTA`, `CTR`, `FIR`, `Military`, `Danger` and `Restricted` areas are automatically labelled by the ANR import process. - -The only user configurable airspace types are `ENR`, `MFIR` and `TMA`. - -!!! info "" - Airspace imported as `ENR`, `MFIR` or `TMA` will be exported to the dataset in line with the ExportID. The `ENR` type will be exported as an Enroute map, `MFIR` as a FIR map, and `TMA` as a TMA map. - - -### Export IDs - -The SFG is capable of storing multiple unique airspace definitions, and exporting them to multiple differing platforms. This is achieved through the `ExportID` column. - -Each piece of airspace is tagged with one of the following `ExportID`, dictating which products it is exported to - - -* `NZZC` - Exported to both vatSys/ES and vatSpy -* `VSPY` - Exported **only** to vatSpy -* `VSYS` - Exported **only** to vatSys/ES -* `NZZCVSYS` - Exported **only** to the NZZC vatSys/ES release -* `NZZO` - Exported to the Oceanic profile and vatSpy -* `NZZOVSYS` - Exported **only** to the Oceanic vatSys profile -* `NZZCNZZO` - Exported to both vatSys/ES profiles, and to vatSpy. - -!!! warning "" - Airspace imported from the NZ ANR are automatically labelled with the `NZZC` ExportID. If an export ID isn't provided in the Import Limits Line, it is imported as `NZZC`. - -## Format Overview - -Each file has a header line defining the type of airspace, before a name and limits line. The header line will be covered in the examples, as they're self-explanatory. - -### Limits Line - -The Name and Limits Line defines how this is represented in the database. - - -``` title="Limits Line" -[Ident] [Type] [Airspace Class] [UpperLimit] [LowerLimit] [Optional Export Tag] - -For example - -NZCT Taranaki Only ENR C 99900 FT 0 FT VSYS -NZCT-A Taranaki with Ohakea ENR C 99900 FT 0 FT VSPY -NTTT Tahiti Oceanic FIR FIR 999 FL -NSFA Faleolo FIR FIR 999 FL - -``` - -* `Ident` - As referenced in the Unique Airspace Identifiers section. -* `Type` - TMA, ENR or MFIR. -* `Airspace` Class - A, C or D. -* `UpperLimit` - Upper Limit in either FT or FL. EG 0 FT, 3500 FT, 130 FL. MFIR only has an upper limit. -* `LowerLimit` - Lower Limit. As above. -* `Export Tag` - As above. - -### Boundary Lines - -Boundary Lines are defined immediately after the Name and Limits line. - -``` title="Boundary Lines" -[Ident] [SequenceNum] [Lattitude] [Longitude] [LineType] [ArcDef] - -For example - -NZT001 5 403753.80S 1745231.60E GRC -NZT001 6 394745.20S 1744603.20E CWA 401234.58S 1752331.05E 38.00 NM - -``` - -* `Ident` - Must match the ident used in the Name and Limits Line. -* `SequenceNum` - A unique line identifier. Starts at 0. -* `Lattitude` - Latitude in eAIP format. -* `Longitude` - Longitude in eAIP format. -* `LineType` - Either `GRC`, `CCA`, `CIR`, `CWA`, `RHL` or `FNT`. -* `ArcDef` - As needed to define an arc or circle. - -## Examples - -Here are some examples that are currently in our database. - -``` title="Taranaki Sector (for vatSpy only)" -EnRoute Airspace (ENR) -NZCT-A Taranaki with OH ENR C 99900 FT 0 FT VSPY -NZCT-A 0 390738.100S 1713321.701E GRC -NZCT-A 1 390026.071S 1741102.159E GRC -NZCT-A 2 391349.109S 1745455.602E GRC -... -NZCT-A 20 413400.000S 1701435.005E GRC -NZCT-A 21 412527.005S 1702324.000E CWA 412013.600S 1744902.000E 200 NM // WN VOR -NZCT-A 22 390738.100S 1713321.701E GRC -``` - -!!! note "Multiple in one?!" - You can import multiple pieces of airspace in the same file, just by defining additional Name and Limits! - -``` title="NZZO for vatSpy" - -Manual Flight Information Regions (MFIR) -NZZO-A Auckland Oceanic FIR FIR 999 FL VSPY -NZZO-B Auckland Oceanic FIR FIR 999 FL VSPY -NZZO-A 0 300000.00S 1310000.00W GRC -NZZO-A 1 600000.00S 1310000.00W GRC -NZZO-A 2 600000.00S 1800000.00W GRC -NZZO-A 3 250000.00S 1800000.00W GRC -NZZO-A 4 135508.00S 1750623.00W GRC -NZZO-A 5 050000.00S 1711000.00W GRC -NZZO-A 6 050000.00S 1570000.00W GRC -NZZO-A 7 300000.00S 1570000.00W GRC -NZZO-B 0 280000.00S 1680000.00E GRC -NZZO-B 1 250000.00S 1712500.00E GRC -NZZO-B 2 250000.00S 1800000.00E GRC -NZZO-B 3 600000.00S 1800000.00E GRC -NZZO-B 4 600000.00S 1630000.00E GRC -NZZO-B 5 450000.00S 1630000.00E GRC -NZZO-B 6 300000.00S 1630000.00E GRC - -``` - -## TMA - -TMAs follow much the same import format, with a few changes - - -* `NZTnnn` must be the Ident, in order to conform with the AIP. -* `MyIdent:Terminal Name` must be used as the Name. - -!!! warning - `NZTnnn` is only used during the import process to define the sequence, and `NZTnnn` is **not** imported at the Ident in the database. `MyIdent` should be set as the Ident you wish to be the Ident in the database, with `Terminal Name` being the name of the TMA. - -``` title="TMA Import" -Terminal Airspace (TMA) -NZT001 NZOH:Ohakea Approach TMA C 0 FT 0 FT -NZT001 0 451213.40S 1681524.00E GRC -... -NZT001 5 451213.40S 1681524.00E GRC - - -``` - -## Importing Airspace - -Airspace can be imported to the database by heading into the 'DB Update' screen, clicking on 'Import eAIP Airspace`, and navigating to your file. You'll get an alert when the changes have been made. - -Likewise, you can also convert your eAIP definitions using the Airspace Converter utility. - -## Deleting Airspace - -It couldn't be easier! You just need a file containing the following: - -``` title="Delete Airspace" -For MFIRs: - Manual Flight Information Regions (MFIR) - NZDelete [Ident] FIR [UpperLimit] [ExportID] - -For ENR: - EnRoute Airspace (ENR) - NZDelete [Ident] ENR [AirspaceClass] [UpperLimit] [LowerLimit] [ExportID] - -For TMA: - Terminal Airspace (TMA) - NZDelete [Ident] TMA [AirspaceClass] [UpperLimit] [LowerLimit] - -``` - -??? hint "Importing and Delete in the same file" - Follow this example! - - ``` - EnRoute Airspace (ENR) - NZDelete NZOH ENR C 99900 FT 0 FT VSPY - NZOZ Ohakea(Test) ENR C 99900 FT 0 FT VSPY - - NZOZ 0 395040.898S 1782455.300E GRC - NZOZ 1 390908.000S 1774518.799E GRC - ... - NZOZ 19 404502.509S 1752411.023E GRC - - ``` - - -## Manual IFR Waypoint Definitions - -!!! note "" - Refer to [Procedure Editor / Overview](../procedures/index.md#procedural-waypoints). - -To manually import waypoints into the SFG database: - -1. Find the coordinates of the waypoint in DMS format: `Sxxx.xx.xx.xxx Exxx.xx.xx.xxx` -2. Create a `.txt` document, and create your waypoint definition. -3. Import this file into the SFG database by clicking ++"Import Manual IFR Fix"++ on the DB Update page, and then selecting the created text file. - - -``` title="IFR Import File Format" - [WAYPOINT NAME] [COORD LAT] [COORD LONG] - - // Example: - KM563 S041.11.34.000 E172.03.10.000 - HT518 S043.49.01.000 E168.59.30.000 -``` - -It is important to note that: - -* Ordinarily, you should never need to import NZZC non-procedural waypoints. These should be in the ANR. -* You should never import Pacific fixes, as these are imported using Navigraph as a data source. -* A lot of procedural waypoint coordinates can be sourced through a third-party mapping provider, such as LittleNavMap. diff --git a/docs/contribute/sectorfiles/datamanagement/databaseupdating.md b/docs/contribute/sectorfiles/datamanagement/databaseupdating.md deleted file mode 100644 index a0849e5c..00000000 --- a/docs/contribute/sectorfiles/datamanagement/databaseupdating.md +++ /dev/null @@ -1,79 +0,0 @@ ---- - title: Database Updating ---- - ---8<-- "includes/abbreviations.md" - -The SFG uses the ANR as the primary source of data for the NZZC dataset. For the Pacific dataset, the primary source is a locally stored copy of the Navigraph database. - -The ANR data released by Airways is on a 56-day release schedule, usually meaning that the Dataset will vary between a minor and major release every cycle. - -**Minor releases** are releases where the ANR *has not* been updated, and is usually a great time to implement new features or positions or fix errors in the dataset. **Major releases** are releases where the ANR *has* been updated, and usually requires a significant rework of locally defined procedures within the dataset. - -## Updating the ANR Data - -There are two methods of updating the ANR data - automatic and manual. The automatic mode will download the ANR from the AIP website, convert them from PDF to text, before running them against regex patterns to process and import them into the database. - -### Import Process - -When importing `.pdf` files, the SFG will first convert them from a PDF to a text file. The SFG then parses that text file. If there are any import errors that need rectification, you should edit the `.txt` file, **not** the .pdf or the cleaned txt. - -### Automated Updates - -The automatic ANR update will download the latest documents from the AIP website, convert them from PDF to Text, before running them against various regex patterns to process and import them into various database tables. - -To perform an automatic update, navigate to the `DB Update` tab and click on ++"Extract and Import all eAIP Data"++. You should now see the progress bar, alongside the file currently being worked. - -!!! important - It is normal to see various errors during the import process, particularly with the Aerodrome and Airways imports. The SFG will notify you of errors as they occur - so make a note. The error prompt will also notify you of the suggested fix. - - You will most likely encounter an error when importing the Part 95 Routes file, which contains all airways for both NZZC and NZZO. The error prompt will alert you to the specific Type, Identifier and Sequence that is producing the error. This will require you to manually review and fix the faulting sequence(s). - - You will then be required to import the amended file through the manual import process. - -### Manual Updates - -Manual ANR updates are easy, thanks to an automated import. On receipt of an advance copy of the ANR, open the SFG, and navigate to the Utilities screen. Just above the orange Extract button, select the `Use ANR Zip File` button, then click the orange Extract button. - -This will then prompt you to select a file. Select the `.zip` file you have just downloaded. The SFG will then process the files as per an automated import. - -## Updating the Pacific data - -Due to the Pacific having multiple data sources, it is easier to pull from the Navigraph data. This unfortunately means that the data is always a cycle behind, but it is preferential against having to go digging through the French AIP. - -To achieve this, the SFG will find the locally stored vatSys copy of the Navigraph data, and will import that depending on various checks. - -### Automatic Update - -!!! information - As the SFG pulls from the vatSys copy of Navigraph data, you will need to make sure you have the latest version. This can be done by opening vatSys and navigating to `Settings > Navigraph > Check for Updates`. - -To perform an automatic update, navigate to the `DB Update` tab and click on ++"Import Pacific Data"++. You should now see the progress bar, alongside the file currently being worked. - -### How the data is processed - -The Pacific data imported, as well as some of the exported data, is filtered by two boundaries defined in `AIRAC Testing/SFG Data/NZZC NZZO Check Boundaries.xml`. - -The NZZO Check Boundary is the boundary of the NZZO, NTTT and TSN sectors. Only data that exists within these boundaries are imported from the Navigraph data. - -The NZZC Check Boundary is a boundary 4nm inside the actual NZZC FIR boundary. This is used during the export process to specifically exclude some of the data from being produced the in the Pacific dataset, such as airways and fixes inside the NZZC. This is located 4nm inside the FIR to ensure that FIR Boundary fixes are exported. - -There are eAIP formatted versions of these two boundaries in the same data directory that can be adjusted, although it shouldn't be necessary. - -## Solving Errors - -Occasionally you will get parsing errors where there are errors in the `.pdf` files. The SFG will alert you to the file that is faulting, and then instruct you to reimport it manually. - -When editing the text file, ensure you are double checking the parsed PDFtoText file with the original PDF. Common issues include poor formatting, duplicated entries, and mismatched sequences. If you encounter any of these, you should let the author of the PDFs know. - -After solving the error, you will need to reimport the file manually. You can do this by clicking the corresponding button on the `DB Update` screen, and then selecting the file. - -| Required Import Button | Files | -| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Airports | Aerodrome Coordinates | -| Airspace | Common Frequency Zone (CFZ)
Controlled Airspace (CTA)
Controlled Airspace (CTR)
Controlled Airspace (OCA)
Danger Areas (D)
Flight Information Regions (FIR)
Mandatory Broadcast Zones (MBZ)
Military Operating Areas (MOA)
Restricted Areas (R)
Holding (Enroute) | -| VFR Fixes | Visual Reporting Points (VRPs) | -| IFR Fixes | Designated Points (ICAO) | -| Navaids | Navaids | -| Airways | Routes | -| Not Used | General Aviation Areas (GAA)
Low Flying Zones (LFZ)
Mountainous Zones (NZMZ)
Parachute Landing Areas (PLA)
Transit Lanes (T)
Volcanic Hazard Zones (VHZ)
Right Hand Circuits | diff --git a/docs/contribute/sectorfiles/datamanagement/procedurecheck.md b/docs/contribute/sectorfiles/datamanagement/procedurecheck.md deleted file mode 100644 index 794d5e74..00000000 --- a/docs/contribute/sectorfiles/datamanagement/procedurecheck.md +++ /dev/null @@ -1,50 +0,0 @@ ---- - title: Procedure Cross-Checking ---- - ---8<-- "includes/abbreviations.md" - -The SFG has a utility that allows you to cross-check between the procedures stored in the database, and the procedures promulgated in the ANR Part 95 procedure sheets. There are some limitations that are described below. - -The procedure sheets are updated every ANR cycle, and can be found under [ANR Part 3.2 and 3.3](https://www.aip.net.nz/document-category/Air-Navigation-Register). Additionally, it will be included with any advance copy of the ANR. - -!!! warning "Final Checks" - The Procedure Checker should be run as a part of the final release checks for the dataset. Even if you haven't amended any procedures, it can be useful in identifying any existing errors. - -## Limitations - -The ANR currently only describes procedures for RNAV or RNP procedures, so will not contain any radar or VOR-based departures, such as the NZPM `GOLF 2`. - -## Process - -### Running the Checks - -1. Navigate to the `Check Data` tab, and select which categories you wish to cross-check. By default categories A through D will be checked, with H disabled. -2. Click on ++"Check SID/STAR Names"++, which will open a dialog box. Navigate to the location where the ANR Check Files are stores, and using the ++"CTRL"++ key, select both the SID and STAR files, then click ++"Open"++. The SFG will then run its sequence. - -!!! tip - The SFG will save the output file in the same directory where the source files are located, and **not** the current AIRAC working directory. - -### Understanding the Checks - -The layout for the output is - - -1. SIDs that are in the ANR Domestic Departure list, but not in the Database -2. SIDs that are in the Database, but do not exist in the ANR Domestic Departure list. -3. STARs that are in the ANR Domestic Arrivals list, but not in the Database. -4. STARs that are in the Database, but do not ecist in the ANR Domestic Arrivals list. - -For points 2 or 4 above, this is where you will find non-RNAV approaches listed, such as radar departures, or VOR-based procedures such as the NZAR `CABLE 1` departure, or the NZNR `NR 2A` arrival. - -### Responses - -- For procedures that are listed in Section 1 and 3 above, you should investigate as to why there is a discrepency. These could be: - - a completely missing procedure, - - a mislabelled procedure, such as a misspelled waypoint name or an incorrect designator, - - that the procedure has been assigned to the incorrect runway - - in this case, the procedure should also be listed in Section 2 as existing in the database but not in the ANR. - -!!! info "ANR File containing old data" - Sometimes the ANR will contain historical data, where previously removed files still exist in the file, but newly released procedures have also been inserted. In this case, use the AIP website to confirm that these procedures no longer exist. - - diff --git a/docs/contribute/sectorfiles/filestructure.md b/docs/contribute/sectorfiles/filestructure.md deleted file mode 100644 index e0fa0ed7..00000000 --- a/docs/contribute/sectorfiles/filestructure.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Folder File Structure ---- - ---8<-- "includes/abbreviations.md" - -The Sector File Generator works inside of its' own `AIRAC Testing` directory, which can be found in your `Documents` folder. This directory is organized into each AIRAC release, and these folders are generated when the SFG detects a change in set AIRAC cycle on the main screen. - -## Folder Structure - -The overall file structure of the working directory is fairly simple. Most of these folders are generated automatically, and are discussed in detail below. - -``` -- 2210 Updates - - NZ Euroscope Export - - Test-NZ - - Test-NZ Combined Oceanic - - Vatsys-NZ - - Vatsys-NZ Combined Oceanic - - Procedure Maps - ES_master.ese - VATNZ Boundaries.geojson - -``` - -### NZ EuroScope Export - -This directory is created when the ++"Export Euroscope"++ button is clicked. Four files are generated in this folder - a single ESE and SCT2 for both NZZC and NZZO. - -### Test-NZ - -This is the SFG's main working directory for changes to NZZC data. Files found in here include: - -* The original .pdf files for the ANR import, as well as the result of the PDFtoText conversion. Any files that have failed to be processed are also found here. -* All airspace conversions that are processed on the DB Update screen. -* Exported IFR and VFR Plan G fixes. -* Any Test Sector Files as generated from the Procedure Editor. - -### Test-NZ Combined Oceanic - -Same as above, but for Combined Oceanic data only. - -### Vatsys-NZ - -This is the folder where the SFG generates the latest vatSys release for NZZC. The file structure inside is identical to the Profile folders inside the main vatSys directory. Once the export has finished, you can copy the files from this folder into your vatSys Profiles folder for testing. - -!!! info - When the SFG goes through its' export routine, only the dynamic files are generated. Files such as `Sector.xml`, `Volumes.xml` are manual, and are checked during the export routine for data integrity. As such, if these files **do not** exist within this folder, the export will fail. Therefore, you should copy the most recent release version of the Dataset and paste it into the folder **before** performing your first export. This way the SFG will overwrite the necessary files, and all of the integrity checks will pass. - -### Vatsys-NZ Combined Oceanic - -This is the same as above, but for the Combined Oceanic Dataset. The same note applies. - -### Procedure Maps - -This folder contains individual procedure maps that have been generated using the ++"Create map for selected procedure"++ button within the Procedure Editor. \ No newline at end of file diff --git a/docs/contribute/sectorfiles/index.md b/docs/contribute/sectorfiles/index.md deleted file mode 100644 index 081633c7..00000000 --- a/docs/contribute/sectorfiles/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Sector Files ---- - ---8<-- "includes/abbreviations.md" - -# Sector Files - -!!! warning - These Sector File SOPs are still a work in progress, and does not contain complete information. - - Typically as new releases are pushed to the Client, these SOPs will be updated with that information. - -## Overview - -VATNZ Controller Client data is managed through a Sector File Generator app and a dedicated standalone SQL database; allowing for multiple outputs from a single data source. - -The Controller Data is updated in line with the AIRAC cycles, however the ANR is only updated every two cycles. - -## Features - -The SFG app can perform the following functions: - -* One-click download **all** data from the Air Navigation Register, or one-click import for a provided advance copy, and input into `nzsectorfiles.sql`, -* Allow for the importing of manual airspace definitions, such as Enroute and TMAs, -* Allow for the conversion of various formats. For example from eAIP draw format to Sector File/Sector Line/vatSys Airspace Map, Volume/vatSpy boundary and GeoJSON, -* Allow for the merging of airspace, through eAIP definitions (albeit with some limitations), -* Allow for the manual import and mapping of different procedures (STARs, SIDs, VFR arrival/departures, GNSS and RNP approaches), as well as the cross-checking between AIP promulgated procedures and the procedure database, -* Allow for the export of individual procedures to an independant map for Documentation, -* Conversion between different coordinate types (SCT/eAIP/Dec. Degrees/ISO Deg, DegMins, DegMinsSecs), -* Generate an eAIP output from a vatSys airspace map, -* Various vatSpy utilities. - -The SFG can export to both vatSys and EuroScope. The App runs various export routines that produce the various necessary outputs - `XML` for vatSys and `SCT2 / ESE` for EuroScope. - - diff --git a/docs/contribute/sectorfiles/masterese.md b/docs/contribute/sectorfiles/masterese.md deleted file mode 100644 index 5cba08b7..00000000 --- a/docs/contribute/sectorfiles/masterese.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: Master .ese File ---- - ---8<-- "includes/abbreviations.md" - -# Understanding the ES_master.ese File - -The Master .ESE file dictates a few functions in the SFG - - -- Defines all of the Positions in the Datasets (FSS, ENR, TMA, TWR, ATIS) -- Defines all of the master Airspace outlines for ES (Both SectorLines and SECTORs) -- Defines all FIR_COPX definitions -- Can contain additional Free Text, which is exported to both vatSys and ES -- Defines all RADAR positions for both vatSys and ES. - -## Modifying the Data - -### Writing - -You can export the Master .ESE by clicking on ++"Write Master .ese"++ in the Export window of the SFG. - -### Updating - -You can import the Master .ESE by clicking on ++"Import ESE"++ in the DB Update window of the SFG. - -## Positions Master - -This section defines all positions within the Dataset, in addition to ATIS connections, and adjacent sectors for hand-offs and error checking. These definitions follow the standard position nomenclature as defined in the [EuroScope documentation](https://www.euroscope.hu/wp/ese-files-description/){ target=blank }. - -``` -// Format -::::::::::[::[: ... ]] - -// Example -NZOH_TWR:Ohakea Tower:134.500:TOH:T:NZOH:TWR:-:-:6601:6700 - -``` - -!!! note - A stations identifier should be unique, and easily identifiable. For example, Ohakea Tower has the TOH identifier, whereas Approach has Oa, and Ground has GOH. - - Manual VIS center definitions should not be used. - -### ATIS Positions - -All aerodrome ATIS' should be entered in the `[POSITION]` register. The start of these entries are denoted by a semi-colon (`;`) to tell the SFG that they are not Control Positions. - -``` -// Format -;:::ATIS - -// Example -;Ohakea ATIS:135.000:NZOH:ATIS -``` - -### Adjacent Sectors - -It's good pratice to also include adjacent sectors in our `[POSITIONS]` definition. This makes sure that they are shown in the online sectors list, and any handover or coordination pop-ups. - -These follow the same format as shown above, but should have `#` appended to the name of the position. This makes sure that that sector is **not** included in the vatSpy testing dialog box. - -``` -// Example -BN-INS_FSS#:Brisbane Radio:129.250:INS:O:BN-INS:FSS:-:-:-:- -``` - -### Usage of this Data - -These position populate the `POF` database table. - -During an export, the `POF` table is used to - - -- The callsigns in `Sectors.xml` are compared to the `POF` table, and all frequencies are cross-checked. If there is a difference, the sectors file is updated to the frequency listed in the `POF` table. -- The SFG checks that all entries in the POF table are included in `Sectors.xml` - if not, they are added. They won't have a volume defined, so they won't be used or appear in the sector list. - - This is how we have adjacent sectors like `BN-TSN` show up in `Sectors.xml`, but not in the manual sector selection window. -- A check is also run to see if a Callsign in `Sectors.xml` does not exist in the `POF` table. If this is the case, it'll alert you to update the Master ESE. - - -!!! info - You will be alerted if the SFG makes changes to any data. - -## Master Airspace Outlines - -The master airspace outlines are contained within the `[AIRSPACE]` section. - -This section is exclusively used for EuroScope to define the lateral limits of a airspace sector. - -!!! hint - These `COORD` definitions can be converted from eAIP definitions to Sectorline or Sector File outputs using the Airspace Converter utility. - -### Sectorlines - -The Sectorline definitions should follow the standard as defined in the [EuroScope documentation](https://www.euroscope.hu/wp/ese-files-description/){ target=blank }. - -These are typically discrete sections of airspace, that can be added together to form an outline of the airspace you're wanting to define. These are added together in a separate `SECTOR` definitions, underneath the Sectorline definitions. - -### Sector Definitions - -The Sector definitions then add all of the Sectorlines together to form an outline of the airspace. These are fairly straightforward, and the current examples in the Sector Files should be used as a guide. - -## FIR_COPX (Coordination Points) - -These are a list of all manual coordination points in EuroScope. These are \ No newline at end of file diff --git a/docs/contribute/sectorfiles/procedures/.pages b/docs/contribute/sectorfiles/procedures/.pages deleted file mode 100644 index 6005c3e8..00000000 --- a/docs/contribute/sectorfiles/procedures/.pages +++ /dev/null @@ -1,11 +0,0 @@ -# Edit this page to get: -# - Title for the whole directory -# - Titles for specific pages or subdirectories -# - Order of pages (otherwise alphabetical order) - -title: Procedure Editor -nav: - - index.md - - departures.md - - arrivals.md - - ... \ No newline at end of file diff --git a/docs/contribute/sectorfiles/procedures/approach.md b/docs/contribute/sectorfiles/procedures/approach.md deleted file mode 100644 index 0ef4320b..00000000 --- a/docs/contribute/sectorfiles/procedures/approach.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Approaches ---- - ---8<-- "includes/abbreviations.md" - -The Sector File Generator can currently handle RNP, RNP-AR, LOC and VOR approaches; although we don't model LOC or VOR approaches in our dataset. - -These approaches are largely only useful for vatSys, and are used in Euroscope for information only. In vatSys, this data will automatically link with a STAR with a common IAF upon STAR assignment, allowing for route prediction far in advance. - -These approaches are also given their own map layers - - -* `Maps/RNP` shows all RNP approaches in the country -* `Maps/RNP-AR` shows all RNP-AR approaches in the country -* `Maps/ICAO/XX RNP` shows all RNP approaches for that runway -* `Maps/ICAO/XX RNP-AR` shows all RNP-AR approaches for that runway - * For the ICAO-specific maps, there is also an associated labels file that annotates some of the key waypoints. - -As with the STAR section, the principles of procedure editing laid out in the [SID Section](departures.md) are also applicable here - - -* Fixes should be entered in the order in which they are flown. -* For procedures with transitions, the base procedure should be added first, with the transitions added after. -* The delete buttons behave in the same way. -* The general screen layout is the same. - - -## Editor - -### Adding a New Procedure - -
- ![SID Screen](../assets/NewApproach.png){ width="100%" } -
- -Adding a new procedure is relatively simple. `RNP` should be chosen for normal GNSS based approaches, whereas `RNP-AR` should be chosen for high-accuracy procedures. This will be stipulated on the chart. An Alpha designator can be added if required. - -
- ![SID Screen](../assets/PopulatedApproach.png){ width="100%" } -
- -The above image shows the RNP S RWY 23L (AR) approach into Auckland. As you can see, we have new markings next to some of the waypoints. - -* The **Black Triangle** denotes the approach's Initial Fix (IF). -* The **Maltese Cross** denotes the approach's Final Approach Fix (FAF). -* The **Hollow Triangle** denotes the approach's or transition's Initial Approach Fix (IAF). - -These can be designated by highlighting the fix, and clicking the respective button. This does a couple of things - - -* Tells the SFG to create a text label for that waypoint in the various map layers. - * All points designated as an IF, IAF or FAF will have a label generated. -* Will assist the SFG in automatically linking STARs and Approaches together in the export. - -!!! important - You can have multiple waypoints designated as an IAF. For example, on most GNSS-based RNP approaches, the initial straight-in leg will typically be an IAF, in addition to 90 degree offset IAFs. - - For a RNP-AR approach, usually there is only one per transition. - -### Modifying a Procedure - -Procedures can be modified by finding the procedure in the main window, and then modifying the respective data. The data will save if you attempt to navigate away from the procedure by either closing the window or select another procedure. \ No newline at end of file diff --git a/docs/contribute/sectorfiles/procedures/arrivals.md b/docs/contribute/sectorfiles/procedures/arrivals.md deleted file mode 100644 index 2a43c784..00000000 --- a/docs/contribute/sectorfiles/procedures/arrivals.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: STARs ---- - ---8<-- "includes/abbreviations.md" - -Arrivals are the easiest procure to model in the dataset, due to most arrivals being fix-to-fix navigation. - -Most of the principles of procedure editing laid out in the [SID section](departures.md) are also applicable here - - -* Fixes should be entered in the order in which they are flown. -* For procedures with transitions, the base procedure should be added first, with the transitions added after. -* The delete buttons behave in the same way. -* The general screen layout is the same. - -## Editor - -### The STAR Screen - -
- ![SID Screen](../assets/PopulatedSTAR.png){ width="500" } -
- -STARs have to contain at least two fixes in the base procedure, and should still be entered in the order that they are flown. - -!!! information - Where a procedure has only one waypoint in the base procedure, you will need to enter a custom coordinate that is close to the fix. This is due to both Euroscope and vatSys having to draw a procedure from point-to-point. - - You can find this coordinate by following the same directions as shown on the SID page for creating a custom coordinate. - -### Add New Procedure - -Adding a new procedure can be done by following the same directions as for adding a SID. - -The only difference here is that you should designate what fix is the Initial Approach Fix (IAF). This can be done by clicking on the desired point, and clicking on the `IAF` button. - -!!! tip "Additional Context" - Clicking the `IAF` button does two things - - - * Tells the SFG to create a text label for that waypoint in the various map layers, and - * Will assist the SFG in automatically linking STARs and Approaches together in the export. - -### Modifying a Procedure - -Procedures can be modified by finding the procedure in the main window, and then modifying the respective data. The data will save if you attempt to navigate away from the procedure by either closing the window or select another procedure. diff --git a/docs/contribute/sectorfiles/procedures/deleting.md b/docs/contribute/sectorfiles/procedures/deleting.md deleted file mode 100644 index ea48b3ef..00000000 --- a/docs/contribute/sectorfiles/procedures/deleting.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Deleting a Procedure ---- - ---8<-- "includes/abbreviations.md" - - -In order to delete a procedure from the editor, you need to first navigate to that procedure, and select the applicable checkboxes that apply to your situation. - -| Checked boxes | Action | -| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| None | Delete all procedures that have the same name, irrespective of runway. (IE all Auckland DAVEE STARs) | -| Runway | Delete all procedures with the same name for that runway (IE all Auckland DAVEE STARs for 05R) | -| Runway, Number | Delete all procedures with the same name and numeric character for that runway (IE all Auckland DAVEE STARs for 05R at number state 7) | -| Runway, Number Alpha | Delete all procedures with the same name, number and alpha. | - -!!! hint - There is a confirmation dialog box that appears listing all of the affected procedures, so you will have a chance to make sure you have the correct query. - -!!! info - You cannot felete a single base procedure (no transition), if that procedure has transitions assigned. If you wish to delete a procedure and all of its' transitions, you should select the procedure and tick the Runway, Number and Alpha boxes. Remember to confirm your selection before confirming the deletion. diff --git a/docs/contribute/sectorfiles/procedures/departures.md b/docs/contribute/sectorfiles/procedures/departures.md deleted file mode 100644 index 2e050ca1..00000000 --- a/docs/contribute/sectorfiles/procedures/departures.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: SIDs ---- - ---8<-- "includes/abbreviations.md" - -SIDs are often the more difficult procedure to model in the dataset, as they often have a lot of variables associated with them, such as aircraft performance based turns; and differing ARINC leg types such as course to fix and altitude to fix. - -![Hello](../assets/Echo5.png){ width=350 align=right } - -When translating procedures, it is often better to translate them as it they were for the average aircraft. For example, in a performance-influenced departure like the `ECHO5` out of Palmerston North, a prop will make a more drastic turn at a lower speed when compared to a faster jet aircraft. - -## Editor - -### The SID Screen - -
- ![SID Screen](../assets/SIDScreen.png){ width="500" } -
- -The above image shows the screen for a fully populated procedure. The screen is well annotated within the app, although there are a few key things to know about the behaviour of the app - - -* Changing the Runway will update all transitions for that procedure. -* Changing the Name will update all transitions for that procedure. -* Changing the Number will update all alphas and transitions for that procedure. -* Changing the Alpha will update all transitions for that procedure. -* Changing the Transition will update only the selected procedure. - -The aircraft type box will alter what aircraft this SID can be made available to in the vatSys FDRs. Ticking the `Radar SID` box will make the SID the default for non-RNP/RNAV aircraft. Ticking the `Default SID` box will make it the default SID assigned to traffic for that runway. - -The ++"Delete this Procedure"++ button will delete the individual procedure selected. If you have a transition selected, it will only delete that transition. The ++"Delete every Procedure with this name"++ button will delete every procedure with the same Procedure Name - regardless of whether or not it is on the same runway or not. - -The two boxes below are the fix boxes. The procedures should flow from top to bottom in the order that they should be flown. The box on the left is the 'base procedure' - -### Add New Procedure - -
- ![SID Screen](../assets/NewSID.png){ width="100%" } -
- -Adding a new procedure is relatively simple - you select the runway applicable, and fill out the other respective fields. - -You can add a SID for either a single runway, or all runways at an aerodrome. Where a procedure might be for multiple but not all runways, you should select all. - - -!!! tip - When adding a procedure that has various transitions, you are required to add the base procedure first. This is the part of the procedure that is common to all of the transitions. Usually on charts, this is solid line portion of the procedure. - - Subsequent transitions can be added by adding a new procedure, entering the base procedure, and then adding the desired transition fix in the `Transition` box. Clicking ++"Add SID"++ will open to the main screen, where you can add the transition route to the right hand text box. - -!!! tip - You can also add custom coordinates to create a custom path, or a manual turning point. This is often used for a 500ft turn point, as can be seen in the above illustration of the `ECHO5` procedure out of Palmerston North. - - You can create this point by looking at the procedure in LittleNavMap, displaying the procedure and placing a custom waypoint where the turn commences. This coordinate can then be converted in the SFG's `DMS Conv` utility to the SCT format, and can be added like any other fix. - - -
- ![Populated SID Screen](../assets/PopulatedSID.png) -
- -The example above shows the `RUXOX4S` for Runway 07 at Palmerston North. - - -* The `PM25T` and `PM07T` fixes are threshold fixes. Normally the opposite end threshold fix is not required, but has been added here, as `VEPUR` is slightly offset from the runway centreline. -* `RUXOX` is the final common fix for the procedure. -* Waypoints `OLMUX`, `OH VOR` and `RUGVI` make up the rest of the transition, and are entered in the order that they are flown. -* The circle next to `OH VOR` designated that it is a ground-based navigation aid, not an IFR waypoint. VOR/DMEs and NDBs all show as a circle. - -!!! warning - Modifying the base procedure while a Transition is selected will update the base procedure for all transitions. - -!!! information - The `IF`, `IAF`, `Fly over` and `FAF` buttons are not applicable for SIDs. - -### Modifying a Procedure - -Procedures can be modified by finding the procedure in the main window, and then modifying the respective data. The data will save if you attempt to navigate away from the procedure by either closing the window or select another procedure. diff --git a/docs/contribute/sectorfiles/procedures/index.md b/docs/contribute/sectorfiles/procedures/index.md deleted file mode 100644 index 336247b8..00000000 --- a/docs/contribute/sectorfiles/procedures/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: Overview ---- - ---8<-- "includes/abbreviations.md" - -!!! warning - Procedures are **not** automatically pulled from the ANR, due to incomplete data and differing formats. These must be updated in line with the ANR. - -The Procedure Editor provides an easy-to-use interface for creating and editing procedures for the aerodromes contained within the database. - -The Procedure Editor covers the following procedures - - -* SIDs -* STARs -* VFR arrivals and departures -* Helicopter-specific procedures (not used) -* Approaches (RNP, RNP-AR, LOC and VOR) - -
- ![Procedure Editor Main Screen](assets/../../assets/ProcEdMainScreen.png){ width="600" } -
- -## How does it work? - -The ProcEd allows the user to create procedures for any of the aerodromes contained within the `contl_apt` or `uncontl_apt` tables. Aerodromes not appearing in either of these two tables will not be able to have procedures created for them - whether they appear in other tables or not, such as `ap_aids`. - -After an aerodrome has been added to either of the required tables, it will show under the `Airport ICAO` dropdown when ++"New Procedure"++ is clicked. The app will automatically pull in the aerodrome's runways, as listed in the `runway` table. - -For procedures that have transitions (SIDs, STARs and approaches), you are required to add the base procedure, and then the various transition routes. This is further defined in the various procedure sections. - -We have chosen not to model helicopter procedures in New Zealand, due to there are not many helicopter procedures in use around the country; and where helicopter procedures *do* exist, they are relatively short. - -## What happens on export? - -On export, the ProcEd largely performs the same actions for both the vatSys and EuroScope releases, but performs and exports them slightly differently. - -### vatSys - -* Each Aerodrome in the `contl_apt` and `uncontl_apt` tables are given their own Map folder within the `Maps` dropdown. The file name `XX_ACU` is dictated by the `icaoabbrv` in the relevant table. -* All the SIDs, STARs and approaches are rendered on their own map layer, sorted by runway. RNP and RNP-AR approaches are given their own map layers, also sorted by runway. - * These are also given custom colours, but these are better explained in the individual procedure sections. -* All VFR arrivals and departures are also given their own map layer, independent of the VRP map layer. - -### Euroscope - -* All procedure layers are rendered into the SIDSTAR section, and are sortable by ICAO. VFR procedures are also rendered in this section. - -## Procedural Waypoints - -There are three types of IFR waypoints in use in the dataset: IFR Significant Points, ICAO 5LNCs and Procedural/Terminal waypoints. Procedural waypoints are used in Aerodrome procedures where there is no need for a named waypoint. - -These waypoints typically follow the format: `XXYYY`, where `XX` is the Aerodrome, and `YYY` are three numbers. For example, the `QN760`, `QN745` and `QN741` waypoints on the `RNP Z Rwy 23 (AR)` approach into NZQN. - -These fixes are not listed in the ANR, and depending on the type of procedure, often don't have their coordinates listed on the plate. - -If you attempt to create a procedure with a procedural waypoint that is not present in the database, you will receive an error, and be notified to [manually define the waypoint using this process](../datamanagement/ManualDefinitions.md#manual-ifr-waypoint-definitions). - -## Threshold Fixes - -In the dataset, custom fixes have been created for each threshold of a runway. These are generated from the runway data provided by the ANR, and don't require any manual attention by the user. - -They usually follow the format of `XXYYT` - where `XX` is the two letter ICAO abbreviation, `YY` is the runway identifier, and `T` denotes the threshold. For example, `PM07T` and `PM25T` denote the thresholds for Palmerston North's single runway. - -Where a runway has an R/L designation, the designator will replace the `T`. For example, `AA23L` and `AA05R` denote the thresholds for Auckland. - -These are mostly used in SIDs, where an origination point is required. These used to be used for approach procedures, but are now appended automatically by the SFG upon dataset export. - -## Exporting a discrete map for a Procedure - -It is possible to export a separate map layer for a single procedure. This can be helpful for when you want to illustrate changes in procedures to the Dataset's users, and exports the procedure exactly how it would normally be seen within an aerodrome's ACU map layer. - -To do this, navigate to the procedure you wish to export in the Procedure Editor, and click on the yellow ++"Create map for selected procedure"++ button. You will then be prompted that the file has been exported, and you will be alerted to this file's location. - -!!! important - When exporting the procedure, the file name will be set to the procedure's name, **however** the map layer's name is not. You will need to manually edit all `Name` attributes within the file to another name, such as the procedure name. - diff --git a/docs/contribute/sectorfiles/procedures/vfr.md b/docs/contribute/sectorfiles/procedures/vfr.md deleted file mode 100644 index 0a640dc1..00000000 --- a/docs/contribute/sectorfiles/procedures/vfr.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: VFR Procedures ---- - ---8<-- "includes/abbreviations.md" - -To be added. \ No newline at end of file diff --git a/docs/contribute/sectorfiles/routines/.pages b/docs/contribute/sectorfiles/routines/.pages deleted file mode 100644 index 589d2bbf..00000000 --- a/docs/contribute/sectorfiles/routines/.pages +++ /dev/null @@ -1,9 +0,0 @@ -# Edit this page to get: -# - Title for the whole directory -# - Titles for specific pages or subdirectories -# - Order of pages (otherwise alphabetical order) - -title: Preparing a Data Release -nav: - - vatsys.md - - ... \ No newline at end of file diff --git a/docs/contribute/sectorfiles/routines/vatsys.md b/docs/contribute/sectorfiles/routines/vatsys.md deleted file mode 100644 index d4db413c..00000000 --- a/docs/contribute/sectorfiles/routines/vatsys.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: vatSys ---- - ---8<-- "includes/abbreviations.md" - -This page describes the routine process for updating the vatSys datasets. The process is relatively straight forward, however can be complicated by the addition of positions, procedures, airspace or features. The process is largely the same between the NZZC and Combined Oceanic datasets, with minor source data changes. - -## Domestic Dataset (NZZC) - -The Domestic Dataset follows an update schedule of every 28 days, and should be released on the effective date of the AIRAC cycle. - -In order to achieve this, processing is required in advance of the release date which poses a handful of issues, mainly surrounding the fact that the ANR and procedure data isn't made public until the effective date of the AIRAC. Therefore, our working relationship with New Zealand's ANSP is paramount to gaining access to the data early. - -### Step 1 - Find changes - -The changes being made to data can be found in the Bulletin. This covers changes within the GEN, ENR and AD sections, in addition to covering all AD 2 Chart changes. - -We use GitHub Issues to track the incoming changes to our data - you can see an [example here](https://github.com/vatnz-dev/new-zealand-dataset/issues/29){ target=new }. You should make a subtask for each change that needs to be replicated in our data. - -### Step 2 - Importing the new data - -!!! danger - Before you update the database, make sure you are using the latest version. Refer to the [Loading the Database from a GitHub Repo](../setup.md#loading-the-database-from-a-github-repo) section of the Setup. - -Once using the latest version of the database, update the database by - - -- [Performing an automatic update of the ANR data](../datamanagement/databaseupdating.md#automated-updates), or -- [Performing a manual update of the ANR data](../datamanagement/databaseupdating.md#manual-updates) - -If there are any errors with the import, you may need to fix the file and reimport it. More information on that [can be found here](../datamanagement/databaseupdating.md#solving-errors). - -### Making the Changes - -Now is your time to make all the changes! - -* You can see how to make changes to procedures in the [Procedure Editor section](../procedures/index.md). -* You can see how to add positions in the [Data Management section](../datamanagement/ManualDefinitions.md). - -!!! danger - After you've made your changes, remember to update the database repository! - -### Exporting the Dataset - -After you've finished your changes, it's time for export! This can be done by clicking the ++"Export vatSys"++ button on the main SFG screen. - -A few points: - -* You should make sure that the current AIRAC version is set correctly on the main Export page. -* The ++"Export vatSys"++ button also exports the Combined Oceanic Dataset at the same time. -* After you export the dataset, it can be found in the `Documents/AIRAC Testing/XXXX Updates/` folder, and then under the `Vatsys-NZ` folder. You will have to copy this into your vatSys directory to test the dataset. If you make any changes afterwards, you will then have to copy the changes from the export folder to your vatSys folder again. - -#### Updating the Profile file - -You will also need to update the `Profile.xml` file prior to release. This is the file that vatSys reads to ascertain the current release, and dictates whether the user is prompted to update their dataset or not. - -``` XML title="Profile.xml" - - - -``` - -The `Version` line should be updated, with the `AIRAC` field updated for the version you are releasing, as well as annotating the effective date in the `PublishDate` attribute. The `Revision` attribute should always be `a`, unless you are releasing a correction to the data outside of the scheduled release timetable. - -### Pushing your changes to GitHub - -!!! danger - Before you push your changes to GitHub, you should ensure that all of the changed files are what you want to release. At times other files generated can slip in - these can be ignored my right clicking file name in the GitHub window, and clicking on Discard. - -When pushing your changes to GitHub, you should have a descriptive commit comment that is short, concise, and is semantic. For example - `routine: Cycle 2210 ANR changes`, `feat: Add new Queenstown procedures` or `fix: Change ATIS pronunciations`. - -After committing your changes to the working repository under the vatnz-dev organisation, you need to open a pull request from that Repo into the main vatSys release repo. This PR will then be reviewed by either the Operations Director, or another individual. - -## Combined Oceanic Dataset - -To be added once COD is released. \ No newline at end of file diff --git a/docs/contribute/sectorfiles/setup.md b/docs/contribute/sectorfiles/setup.md deleted file mode 100644 index bcc1b044..00000000 --- a/docs/contribute/sectorfiles/setup.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Set Up ---- - ---8<-- "includes/abbreviations.md" - -## Introduction - -The Controller Client data is managed through GitHub repositories under the vatnz-dev organization. If you require access to the vatnz-dev organization, let the Operations Director know. - -There are a number of repositories of note: - -* [**ais-data-manager**](https://github.com/vatnz-dev/ais-data-manager){target=new} - Contains the most recent version of `nzsectorfiles.sql`, -* [**auckland-radio-dataset**](https://github.com/vatnz-dev/auckland-radio-dataset){target=new} - Development repo of the Auckland Radio Dataset, -* [**new-zealand-dataset**](https://github.com/vatnz-dev/new-zealand-dataset){target=new} - Development repo of the New Zealand Domestic Dataset, -* [**SectorFiles**](https://github.com/vatnz-dev/SectorFiles){target=new} - Release repo of our EuroScope releases. -* [**vrpsForLittleNavMap**](https://github.com/vatnz-dev/vrpsForLittleNavMap) - Release repo of our LittleNavMap VRPs. - -## Requirements - -The SFG app should run on any PC running Windows 7, 10 or 11. The system must have at least .Net Framework 4 installed. - -Prior to installing the SFG app, you will need to set up the following: - -* [**XAMPP**](https://www.apachefriends.org/index.html){target=new} - XAMPP is an Apache distribution that contains a MySQL server, replicating a live server on your local machine. -* [**GitHub Desktop**](https://desktop.github.com/){target=new} - Needed in order to manage the EuroScope releases, vatSys Datasets and database. - -When setting up XAMPP and MySQL, you have the option to set a username and password for the root user. If you set your own, you're able to set this under `Export > User Options`. - -### Updating of the Database Local Repository - -The SFG has the ability to import an updated version of the SFG database from a GitHub repository, as well as the ability to export the database ready for committal to the AIS Data Manager repo. - -This feature requires you to set the `mysqld.exe` locations in the User Options dialog, found on the Export page. These can typically be found in your XAMPP install directory under `xampp\mysql\bin`. You will also have to set the location of the GitHub repository on your machine. - -!!! warning - While other local development stacks, such as WAMP, also have the capability for this function; the security functions of these stacks prohibit this feature from working properly. Therefore, it is suggested to only use XAMPP for your local stack. - -!!! hint - You can select to export or load the `event_nzsectorfiles` database by selecting the `Event Database` toggle at the bottom of the `Export` window. - -#### Loading the Database from a GitHub Repo - -1. In your GitHub Desktop client, fetch the latest version of the `ais-data-manager` repository -2. On the `Export` page of the SFG, click on ++"Load Database"++ -3. You will be warned of which database you are about to replace. Follow the prompt - -#### Exporting the Database, and updating the GitHub Repo -1. On the `Export` page of the SFG, click on ++"Update Database Repo"++ -2. In your GitHub Desktop client, review the differences. If these look OK, the add your commit summary and description if applicable -3. Commit your changes -4. Inform the other uses of the database that an update has been made - -!!! attention - You should update the database repository whenever changes have been made to the database. \ No newline at end of file