FAI Airscore

This was originally a fork of Geoff Wong's airScore. It has been ported to python 3.7, it's structure has been completely redesigned and many additional features added.

Web middle layer & front end has been ported to flask/jquery using flask cookie cutter template.

Features:

GAP based Paragliding and Hang Gliding scoring from IGC files.

• Formulas are defined in script files which makes implementing new variants easy. (current formulas are GAP 2016-2021 and PWC 2016, 17, 19)
• Scorekeeper access to setup competitions and score tasks.
• Competition scoring with task scores and overall scores publishable to public area of website.
• Airspace infringement detection and penalty application
• Interactive tracklog and task maps
• Ability to have an in house database of pilots, waypoints and airspaces for re-use in multiple competitions
• Live leaderboard and scoring from live tracking servers. (e.g. Flymaster)
• Tracks download status before results are published

The GAP rules have changed over the years. Here are the features that airscore includes or not.

• Scoring Method
  • [ ] GAP
    • [ ] GAP2000
    • [ ] GAP2002
    • [ ] OzGAP2005
    • [ ] GAP2007
    • [ ] GAP2008
    • [ ] GAP2011
    • [ ] GAP2013
    • [ ] GAP2014
    • [ ] GAP2015
    • [x] GAP2016
    • [x] GAP2018
    • [x] GAP2020
    • [x] GAP2021
  • [ ] PWC (GAP variant)
    • [ ] PWC2007
    • [ ] PWC2008
    • [ ] PWC2009
    • [ ] PWC2011
    • [ ] PWC2012
    • [ ] PWC2013
    • [ ] PWC2014
    • [ ] PWC2015
    • [x] PWC2016
    • [x] PWC2017
    • [x] PWC2019
  • [ ] Linear distance
  • [ ] Time-based scoring (TBS)
• Earth Model
  • [ ] FAI sphere
  • [x] WGS84 ellipsoid
• Distance Method
  • [ ] Pythagorus on a UTM plane
  • [ ] Haversines on the sphere
  • [ ] Vincenty on the ellipsoid
  • [x] Andoyer on the ellipsoid
• Type of Task
  • [x] Race
  • [x] Elapsed time
  • [x] Open distance (can be declared but not yet scored)
• Shape of Zone
  • [x] Cylinder
  • [ ] Inverted cone (can be defined but treated as a cylinder)
• Shape of Goal
  • [x] Circle
  • [x] Line
• Final Glide Decelerator
  • [ ] Conical end of speed section (CESS)
  • [x] Arrival altitude time bonus (AATB)
• Source of Altitude
  • [x] GPS
  • [x] Pressure (QNH)
• Validities
  • [x] Task (day quality)
  • [x] Launch
  • [x] Distance
  • [x] Time
  • [x] Stop
• Points
  • [x] Linear distance (reach)
  • [x] Distance difficulty (effort)
  • [x] Arrival position
  • [x] Arrival time
  • [x] Time (speed)
  • [x] Leading
  • [x] Departure
• Leading Area as a Function of Time and Distance Tweaks
  • [x] Use distance; a = t * d
  • [x] Use distance squared; a = t * d^2
  • [x] Use PWCA weighting; a = w(t, d)
• Parameter Tweaks
  • [ ] Day quality override
  • [ ] 1000 points for winner if no pilot made goal
  • [ ] 1000 points for winner before day quality applied
  • [x] Leading points weight
  • [ ] Proportional leading points weight if no pilot made goal
  • [x] Adjustable stopped task bonus glide ratio (fixed at 4:1 for PG and 5:1 for HG)
  • [x] Adjustable turnpoint radius tolerance fractional
  • [x] Adjustable turnpoint radius tolerance absolute minimum
• Special Cases
  • [x] End of the speed section but not goal (adjustable penalty)
  • [x] Early start
  • [x] Stopped tasks
• Stopped Tasks
  • [x] Stopped task time as announcement minus score back
  • [x] Requirements checking, goal or duration
  • [x] Score time window
  • [x] Time points for pilots at or after the end of the speed section
  • [x] Distance points with altitude bonus
• Penalties
  • [x] Absolute
  • [x] Fractional
  • [x] Jump-the-gun factor
  • [x] Jump-the-gun maximum
  • [x] Airspace
• Task Ranking
  • [x] Overall
  • [x] Female
  • [x] Class
  • [x] Country
  • [x] Teams
• Competition Ranking
  • [x] Overall
  • [x] Female
  • [x] Country
  • [x] Teams
  • [x] Ties
  • [x] Fixed Total Validity
  • IGC checks
  • [x] G-record checking
  • [x] file quality checking

Installation:

Airscore is setup to be installed and run inside Docker containers. For production use, Airscore needs a MySQL database to connect to. You will need to setup or use a hosted mysql server. For development use, there is the choice of using an hosted database as above in production or a MySQL database that is in a docker container on the same system as Airscore.

Hosted Database option (Production and Development)

Database setup

The database is not included in the docker containers. Once you have the DB server, use the file airscore.sql to create the table and views. Database credentials should be saved in the .env file (see below)

Environment and configuration variables

defines.yaml.example and .env.example should be renamed or copied without ".example" to create the two config files.

• defines.yaml - folder structure and Airscore configuration - there are several options
• .env contains environment variables used in the docker compose files, database and email server credentials.

If you wish to develop on the host system and run airscore code outside of the docker containers, use the file dev.yaml (rename it from dev.yaml example) to set the variables that would otherwise be environment variables inside the docker containers (and therefore inaccessible to the host system). If the file is present these settings will override what is in the .env file

Application start

This app should be run completely using Docker and docker-compose. Using Docker is recommended, as it guarantees the application is run using compatible versions of Python and Node. You may need to install docker and docker-compose on your system.

There are 2 options to run the app. One is the production configuration and one development. If you are developing you may still want to run the production version as some features of Airscore are incompatible with the flask development web server. Airscore will still work, however some features will not display. If you are running the development configuration the flask development server will provide useful debugging info in the browser.

To run the development configuration of the app

docker-compose -f docker-compose-dev.yml up

To run the production configuration of the app

docker-compose up

Once the app is running you can navigate to localhost port 5000 (typically http://0.0.0.0:5000 or http://127.0.0.1:5000 or htttp://http://localhost:5000) in your browser to use Airscore.

The production version uses several containers running together:

• The flask app
• A worker container for background tasks
• Redis (for cache and background processing queue)
• Nginx

A docker volume node-modules is created to store NPM packages and is reused across the dev and prod versions of the application. For the purposes of DB testing with sqlite, the file dev.db is mounted to all containers. This volume mount should be removed from docker-compose.yml if a production DB server is used.

Local Development Database option

The database is included in the docker containers. The first time the containers run, the database will be setup from the included airscore.sql file. The data will persist when the containers are stopped or rebuilt as it is stored in the dev.db directory on the host system. If you wish to reset the database (delete and recreate) simply delete the contents of the dev.db directory and restart the docker-compose.

As well as the database, the setup also includes Adminer which is browser based DB admin utility. You can access this by navigating to http://localhost:8080/ and logging in with the credentials in the docker-compose file (defaults are: server:db, username:root, password:airscore, database:airscore)

Environment and configuration variables

defines.yaml.example and .env.example should be renamed or copied without ".example" to create the two config files.

• defines.yaml - folder structure and Airscore configuration - there are several options
• .env contains environment variables used in the docker compose files, database and email server credentials.

If you wish to develop on the host system and run Airscore code outside of the docker containers, use the file dev.yaml (rename it from dev.yaml example) to set the variables that would otherwise be environment variables inside the docker containers (and therefore inaccessible to the host system). If the file is present these settings will override what is in the .env file

Application start

This app should be run completely using Docker and docker-compose. Using Docker is recommended, as it guarantees the application is run using compatible versions of Python and Node.

Again there are 2 options to run the app. If you are developing you may still want to run the production version as some features of Airscore are incompatible with the flask development web server. Airscore will still work, however some features will not display. If you are running the development configuration the flask development server will provide useful debugging info in the browser.

Note that the first time you run the docker-compose the database setup may take longer than the application start up. In that case there will be an error. Simply wait until the database is finished (evident in the shell) and stop and restart (ctl-c to stop) However you can avoid this by running the database service by itself the first time:

sudo docker-compose -f docker-compose-dev-local.yml up db 

Once it has finished setting up you can stop it and run all services together with one of the below commands.

To run the development configuration of the app

sudo docker-compose -f docker-compose-dev-local.yml up

To run the production configuration of the app

sudo docker-compose -f docker-compose-prod-local.yml up

Once the app is running you can navigate to localhost port 5000 (typically http://0.0.0.0:5000 or http://127.0.0.1:5000 or htttp://http://localhost:5000) in your browser to use Airscore. Adminer is on localhost port 8080

Running Tests

To run all tests, run

sudo docker-compose -f docker-compose-tests.yml run --rm tests test

flask test # If running from within docker

License

Apart from igc_lib which has a MIT license and bootstrap all rest of the code is provided under the GPL License version 2 described in the file "Copying".

If this is not present please download from www.gnu.org.