Changes between Version 19 and Version 20 of FS Guide


Ignore:
Timestamp:
Feb 17, 2008, 5:18:48 PM (12 years ago)
Author:
Øyvind Ellefsen
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • FS Guide

    v19 v20  
    22= The FS Guide =
    33
     4This guide describes the details about the functions and features of FS. Also see the QuckGuide for a short intro, and NetworkScoring for info on setting up an advanced scoring network.
     5
    46== Installing FS ==
    57
    68Requirements
    7  * Any PC running Microsoft .NET 2.0 (Use Windows update to install directly from Microsoft)
     9 * Any PC running Microsoft .NET 2.0 You can use Windows update to install .NET 2.0 directly from Microsoft if it is not installed on your PC.
    810 * 2 MB free harddisk space for FS itself, you might want some more for tracklogs and such.
    9 It has been tested on Windows 2003 Server, Windows XP and Vista but (teoretically) it should work on any platform as long as .NET 2.0 is installed.
     11
     12FS have been tested on Windows 2003 Server, Windows XP and Vista but (teoretically) it should work on any platform as long as .NET 2.0 is installed.
    1013
    1114
     
    1316
    1417FS will not make any icons on the desktop or start menu for now. Look in the FS folder where you will find the program files that you can start directly.
    15  * FsComp.exe - The main program for setting up and scoring a competiton
     18 * FsComp.exe - The main program for setting up and scoring a competition.
     19 * FsFlight.exe – A basic tracklog data viewer.
    1620 * Participants.xlt - A MS Excel template for quick and easy registering of users. You need to have macros enabled in Excel.
    1721 * lc.xls - A MS Excel workbook for viewing Leading Coefficient graphs. You need to have macros enabled in Excel.
     
    2024== General information ==
    2125
    22 Since FS is quite different than earlier scoring software the scorer should be aware of the general information and concepts. There are many details that are not described in full here, and we recommend the scorer play with the demo data and set up a few test competitions before trying to run a competition with FS for the first time.
     26Since the use of FS is quite different than earlier scoring software the scorer should be aware of the general information and concepts in FS. There are many details that are not described in full here, and we recommend the scorer play with the demo data and set up a few test competitions before trying to run a competition with FS for the first time.
    2327 
    2428=== About the database and competition data ===
     
    4953If you do not believe this is necessary you should do a simple test - create the same two turnpoint task of about 50-100km in a few different types of instruments, then look at the distance shown. We wish these differences could be documented by the makers of the instruments, but it have not been successful so far.
    5054
    51 === About !GpsDump ===
     55=== About !GpsDump === #aboutgpsdump
    5256
    5357FS works well in combination with GpsDump when all communications with GPS devices is handled by !GpsDump. !FsComp and !FsFlight read the tracklog files saved by !GpsDump. !GpsDump can also convert a range of formats to KML, IGC files are for example very common and easily converted with !GpsDump. You are not locked to !GpsDump, and may use any software you like to get the tracklogs downloaded, just make sure it is stored in KML format and named correctly for !FsComp to read and process it.
     
    8589Enter - edit pilot (or new if on empty row)
    8690
    87 Select one or more rows by clicking and dragging, shift-click, or ctrl-click, and use the "Delete" key to remove participants (you're asked to confirm each deletion).
     91Select one or more rows by using normal windows mouse/key combinations - clicking and dragging, shift-click, or ctrl-click, and use the "Delete" key to remove participants (you're asked to confirm each deletion).
    8892
    8993=== Using Excel to enter participants ===
    9094
    91 Another option to get participants into a .fsdb file is to use "Participants.xlt" This is an Excel Template which you just double-click on to create a new spreadsheet, then add participants directly in Excel anyway you like. Follow the instructions written as comments in the spreadsheet. You will need to have macros enabled in Excel for the spreadsheet to work.
    92 
    93 Using Excel gives you the option of adding more information per participant, like paid status, mobile number, etc. It will save you some time in the long run. ''Note: after you have checked the first task and created results you should '''not''' use this to add/update participants as it will remove flight data and results from all tasks.''
    94 
    95 === Importing pilot lists from external sources ===
    96 
    97 If you have a RACE db or a CompeGps .pil file with participants you can import pilots from these files using "Tools/Usefull stuff/Import pilotlist from ..." to initially populate the particpant list.
    98 
    99 Importing from a RACE db when having used it together with !CompeGps you should select "pilNumber" as Pilot Id field from Race, as this is the field that !CompeGps use when manipulating the RACE db and is the ID used in the tracklog filenames.
     95Another option to get participants into a .fsdb file is to use "Participants.xlt" This is an Excel Template which you just double-click on to create a new spreadsheet, then add participants directly in Excel anyway you like. Follow the instructions written as comments in the spreadsheet. Note that you will need to have macros enabled in Excel for the spreadsheet to work.
     96
     97Using Excel gives you the option of adding more information per participant, like paid status, mobile number, etc. It will save you some time in the long run. ''Note: after you have checked tracklogs of the first task and created results you should '''not''' use this to add/update participants as it will remove flight data and results from all tasks.''
     98
     99=== Importing participant list from other external sources ===
     100
     101If you have a RACE database or a CompeGps .pil file with participants, you can import pilots from these files using "Tools/Usefull stuff/Import pilotlist from ..." to initially populate the particpant list.
     102
     103If you are importing from a RACE database when having used it together with !CompeGps you should select "pilNumber" as Pilot Id field from Race, as this is the field that !CompeGps use when manipulating the RACE db and is the ID used in the tracklog filenames.
    100104
    101105If you have a bunch of tracklogs, you can use "Tools/Usefull stuff/Create pilotlist from tracklogs".
    102 The tracklogs must have file name as made by GpsDump in comp mode in order for it to make sense. Also no two tracklogs can have same id.
     106The tracklogs must have file names as made by GpsDump in competition mode in order for FS to make sense of the files. See [#aboutgpsdump About GpsDump]. Also no two tracklogs can have same id.
    103107
    104108For any of the import options above only pilots having id not already in the fsdb will be imported.
    105 In other words, all existing participants will stay as is.
     109In other words, all existing participants will stay as is when importing, to make sure newer data is not overwritten.
    106110
    107111== Tasks and task types ==
    108112
    109 Each task can have it's own scoring parameters. Normally they would be the same for the whole competition, but there can be cases where f.ex. min. dist. should be different because one use a different take off or different wind-direction etc...
     113Each task can have it's own scoring parameters. Normally they would be the same for the whole competition, but there can be cases where f.ex. the GAP minimum distance parameter should be different because one use a different take off or different wind-direction etc...
    110114
    111115=== Distance of a task in FS ===
     
    114118
    115119See detailed TaskDistance description.
     120
     121=== How FS calculate time ===
     122
     123Describe interpolation, start gates, etc. here.
     124
     125Also see description of [#jtg Jump the Gun factor].
    116126
    117127=== Speed of a task in FS ===
     
    129139''See DefinitionList for an accurate description of the terms used below.''
    130140
    131 
    132 Using GPS and FS to score, you can be very creative in the format of tasks. Some examples are listet below, if you invent new task types, please fill in below!
     141Using GPS tracklogs and FS to score, you can be very creative in the format of tasks. Some examples are listed below, if you invent new task types, please fill in below!
    133142
    134143 1. Race with a single start gate: Select task type "Race" and set which turnpoint is start of speedsection (SS) and end of speedsection (ES) then add a single start time.
     
    138147 1. Open distance via turnpoints: Select task type "Open distance" and add a two or more turnpoints. The pilot who get furthest away in any direction from the last turnpoint win the task.
    139148 1. Open distance on a heading: Same as open distance above, but check the "Heading" checkbox and add a "heading" point at the end which gives the heading to fly from the last turnpoint.
    140  1. "Race to nowhere" example: turnpoint 1 a 400m radius circle around take off, turnpoint 2 a 2km radius circle around take off as SS, turnpoint 3 a 50km radius circle around take off as ES. First pilot to ES wins.
    141 
    142 Lots of other types of tasks is possible, turnpoints with big or small cylinders, turnpoints inside/outside each other, f.ex. one can fly from take off out the edge of a 50km circle then back to start again ("Race to nowhere and back").
     149 1. "Race to nowhere" example: turnpoint 1 a 400m radius cylinder around take off, turnpoint 2 a 2km radius cylinder around take off as SS, turnpoint 3 a 50km radius cylinder around take off as ES. First pilot to ES wins.
     150
     151Lots of other types of tasks are possible, turnpoints with big or small cylinders, turnpoints inside/outside each other, for example one can fly from takeoff out the edge of a 50km circle then back to start again ("Race to nowhere and back").
    143152
    144153=== Task definition ===
     
    148157First of all, set the name and date of the task. Normally one would use the name Task 1 for the first task, Task 2 for the next and so on. The UTC offset is copied from the competition setup, but you can change it for each task if you for example run a comp during the switch from daylight savings time.
    149158
    150 Set the formula (GAP/PWC) parameters for the first task, and click "Set as default for the competition" so that you do not have to set it again for each new task.
    151 
    152 Open the waypoint file (Need to be in !GpsDump format), and add all the relevant waypoints to the task. Each waypoint will have opening and closing times, normally the Takeoff, Start gates, and goal will have to be set to differing times for the task.
    153 
    154 ''(More to come here)''
     159Set the scoring formula (GAP/PWC) parameters for the first task, and click "Set as default for the competition" so that you do not have to set it again for each new task.
     160
     161Open the waypoint file (Waypoint file need to be in !GpsDump format), and add all the relevant waypoints to the task. Each waypoint will have opening and closing times, normally the Takeoff, Start gates, and goal will have to be set to differing times for the task. Make sure you do have the correct times on the turnpoints, or you will get very strange results when scoring.
     162
     163See GapParameters for explanation of the different GAP options.
     164
     165==== Jump the Gun factor ==== #jtg
     166
     167This is being used to allow pilots to start early from the start gate. The factor only applies to starting before the first start time. There are a few advantages to this, compared to scoring them 0 for the day. Allowing pilots that do not care about the time to go early is a good thing for the less skilled competition pilots, as they can use the whole day, and also stay out of the traffic while waiting.
     168
     169For the top pilots it can be very dense traffic in the start gate, typically a gaggle will wait in lift under a cloud where visibility might be less than optimal. Allowing pilots to go a few seconds earlier will give a small penalty, but not enough to force dangerous maneuvers to avoid starting 2 seconds too early.
     170
     171The Jump the Gun factor set the penalty that is added to the pilot time when starting early, it does not affect the other bonuses like leading points or arrival bonus. The factor should be high enough to discourage tactical use of this by the pilots, depending on the level of the competition.
     172
     173For Cat 1 competitions the CIVL rules set the factor to 10, and pilots may not start more than 5 minutes early. (At least for hanggliding, not sure if this was decided for paragliding at the CIVL meeting in 2007?)
     174
     175Some examples;
     176
     177 * One pilot wisely enough focus on the traffic instead of the clock, and fly out of the start gate 2 seconds before the first start time. With a Jump the Gun factor of 10 he will have 20 seconds added to his task time.
     178* Another pilot run away from the dense traffic, and fly out of the start gate 5 minutes seconds before the first start time. With a Jump the Gun factor of 2 he will have 10 minutes added to his task time.
    155179
    156180== Waypoints ==
    157181
    158 Waypoint file must be created with GpsDump.
    159 Either as the type "Geographical files (*.wpt)" which looks like this inside:
     182Waypoint file must be created with !GpsDump, or in !GpsDump compatible format. Either as the type "Geographical files (*.wpt)" which looks like this inside:
    160183{{{
    161184$FormatGEO
     
    168191}}}
    169192
    170 !GpsDump can open waypoint files in a number of different formats so if you don't have a file in correct format there is a good chance you can open it in !GpsDump and select the waypoints and save in one of the two formats mentioned above. Look in the OtherSoftware list for utilities to convert file formats.
    171 
    172 Also !GpsDump can of course read the waypoints from a GPS so as long as you are able to get your waypoints into a GPS somehow you're set.
    173 
    174 In the Task window click on the "Open waypoints file" to fill the Waypoints list.
     193!GpsDump can open waypoint files in a number of different formats so if you don't have a file in correct format there is a good chance you can open it in !GpsDump, select the waypoints and save in one of the two formats mentioned above. Look in the OtherSoftware list for other utilities to convert file formats.
     194
     195Another option is to use !GpsDump to read the waypoints from a GPS, so as long as you are able to get your waypoints into a GPS somehow you're set.
     196
     197In the Task window click on the "Open waypoints file" to fill the Waypoints list for the task.
    175198
    176199Double-click (or select and press Enter or right-click...) on a waypoint to add it to the Turnpoints list.
     
    181204== Checking tracklogs etc. in !FsComp ==
    182205
    183 See popup-menus (right-click) in "Tasks" list and "Task participants" list.
    184 For the "Task participants" list some of the menuitems work on the rows you selected.
    185 
    186 After checking tracklogs, setting status for those not having tracklog, etc. you can produce reports from the "Reports" menu.
     206Make sure the tracklogs are saved in the correct folder for the task, you need to set this in !GpsDump and in !FsComp for each task.
     207
     208!FsComp will try to match the tracklog with the pilots in the participant list, based on the filename and timestamp of the tracklogs. !FsComp will only check the tracklogs when asked to do so, if you change or add a tracklog you need to tell !FsComp to check it again.
    187209
    188210If a pilot got several tracklog files the one with last file modified timestamp is checked.
    189211
     212To set the scoring status of a pilot, select the pilot from the list, and right-click or press enter to get the pop-up menu. Depending on your selection you will be asked to enter information like distance, notes, times, etc.
     213
     214One if the very nice features of FS is that the scorer does have absolute control over all data, and can override anything the GPS tracklog might report. This is very useful when the meet director or jury decides something that will affect the scoring, or the tracklogs have errors.
     215
     216To check all tracklogs, select all pilots (Ctrl-A), right-click and select “Check tracklogs(s)” You can check a sub selection, or just one pilot. Another time-saver is the “Check tracklogs of all pilots not yet processed” function, that you should use to check newly downloaded tracklogs.
     217
     218Note: Any penalties applied to pilots are also removed if the tracklog of the penalized pilot is rechecked in FS, make sure you reapply penalties if needed.
     219
     220After checking tracklogs, set status for those not having tracklog. Most will probably be minimum distance, this is done by just setting the pilot status to DF. Remember to set ABS for those not present at takeoff, or DNF for those that chose not to fly for some reason. ABS does not influence the scoring, while DNF ‘’does’’ influence the scoring by reducing day quality.
     221
     222After all pilots have been processed you can produce reports from the "Reports" menu. You can of course produce preliminary reports with some pilots in NYP status, but the reports will probably not be correct as all flights influence the scoring.
     223
    190224Note: nothing happens to the fsdb file itself until you save it ("File/Save ..."). This means you can test different things and discard these by not saving before exiting the program.
    191225
     
    198232Those pilots where one has entered distance or set status manually will keep their data.
    199233
    200 This means one can sort the rows on the status column and mark those rows with status NYP and check tracklogs again or use the menuitem "Check ... NYP".
    201 
    202 Note: any penalties is also removed.
     234This means one can sort the rows on the status column and mark those rows with status NYP and check tracklogs again or use the menu item "Check ... NYP".
     235
     236Note: any penalties are also removed if the tracklog is rechecked, make sure you reapply these if needed.
    203237
    204238'''Open distance task'''
     
    210244== Reports ==
    211245
    212 A set with default reports templates is included. One for task result (task_result.tkr.xsl), one for competition result (comp_result.cpr.xsl), one for team results (team_result.tmr.xsl), and one for participant list (participant_list.ptl.xsl).
    213 These can be used from the respective menuitems under the "Reports" menu.
    214 
    215 If they do not look the way you like (language etc...) just make a copy and open them in a text editor and edit the content. This requires a little knowledge of xml so that one stay away from content that should not be changed.
     246!FsComp will calculate the scores of the task or competition when you ask for a report. Make sure all the tracklogs have been checked, pilot status, etc. before running the report.
     247
     248You can set a few options for scoring when running the reports, you can also add your own options by modifying the templates to add a sponsor logo for example.
     249
     250A set with default reports templates are included.
     251
     252 * Task results – ‘’task_result.tkr.xsl’’
     253 * Competition result – ‘’comp_result.cpr.xsl’’
     254 * Team results – ‘’team_result.tmr.xsl’’
     255 * Participant list – ‘’participant_list.ptl.xsl’’
     256 
     257These can be used from the respective menu items under the "Reports" menu.
     258
     259If the reports do not look the way you like (language etc...) just make a copy of the template, open the template in a text editor and edit the content. This requires a little knowledge of xml so that you stay away from altering content that should not be changed. Feel free to experiment though, and if you make a cool report please upload it to the Wiki!
    216260Note: Keep the extention (from the first .) the same.
     261
     262=== Reports options ===
     263
     264 Status
     265  To set the status of the report, Provisional or Final scores are common status values.
     266
     267 Top_x_tasks (Task results)
     268  Can be ‘’’all’’’ which scores all tasks for each pilot, or a number. This allows for dropping the lowest scoring task for each pilot from the total score.
     269
     270 Women_only
     271  Filter all the males, to get the female results from the competition. Set to ‘’’1’’’ to produce women only results.
     272
     273 Nation
     274  To include only one nation in the report. This can be used when a national comp is run in parallel with an open, to get the national champion.
     275
     276 Custom_pilot_attribute_name/value
     277  Used to filter on custom attributes.
     278