Merge branch 'weglide:master' into master

.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Python application
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+
+    - name: Install pytest
+      run: pip3 install pytest requests
+
+    - name: Run tests
+      run: pytest
+

.gitignore

@@ -6,6 +6,9 @@ __pycache__/
 # C extensions
 *.so
 
+# VSCode
+*.vscode
+
 # Distribution / packaging
 .Python
 build/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 WeGlide 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,5 @@
 ![WeGlide gliderlist](./logo-gliderlist.png)
+
 # gliderlist
 
 Open and standardized collection of gliders. GliderList has two main goals:
@@ -17,13 +18,26 @@ Open and standardized collection of gliders. GliderList has two main goals:
 GliderList is used by WeGlide internally. WeGlide aims to provide numerical data on many aircraft in GliderList for people to do further research with.
 GliderList will be actively maintained and compliance with naming conventions is and will be checked with manufacturers directly.
 
-There exist two lists, base.csv and extended.csv. Base is a list of all base models (e.g. LS 8) where all the different models (e.g. LS 8T) are stated by regular expressions.
-Extended is automatically generated out of base and includes all the different variants of the base models. Only extended includes the unique identifiers.
-
 ## Schema / Documentation
 
 Intent of the following data schema is to be readable for humans and machines while enforcing strict rules and being open to extensions (e.g. other types of information for gliders like polars or numerical information).
 
+## What models are included
+
+Gliders should have a unique row in gliderlist if their handling or engine option differs from existing types.
+
+A unique row is applicable if the aircraft has (compared to existing type)
+
+* Increased MTOW
+* Winglets
+* Different fuselage / wings
+
+It is not applicable if the aircraft has (compared to existing type)
+
+* Automatic control connections
+* A different cockpit
+* A different main wheel / break-system
+
 ### ID
 
 Unique Identifier for this glider. ID is guaranteed not to change and can safely be used as identifier in databases.
@@ -50,22 +64,24 @@ Manufacturer of the aircraft. Sometimes multiple manufacturers are possible so t
 * Open
 * Standard
 
-### Winglets
+### Kind
 
-Whether this aircraft has winglets in case the base model does not have winglets. This field is needed to calculate higher index (+1) based on base model.
-**Warning**: This does not indicate if aircraft has winglets.
+* GL -> Gl
+* MG -> Motorglider (Engine)
+* FG -> FES Glider (FES)
 
 ### Double Seater
 
 Whether aircraft has two seats.
 
-### FES
+### Winglets
 
-Whether engine is of kind FES (Front Electrical Sustainer). Only applicable if Engine evaluates to true.
+Whether this aircraft has winglets in case the base model does not have winglets. This field is needed to calculate higher index (+1) based on base model.
+**Warning**: This does not indicate if aircraft has winglets.
 
-### Engine
+### Exclude from Live
 
-Whether aircraft has **any** kind of motorization.
+Indication if most flights with this aircraft are done in pure powered mode.
 
 ### Year
 
@@ -74,4 +90,4 @@ Competition index (DMSt) for different years.
 ## Contribute
 
 Contributions of new gliders or corrections of naming conventions are very welcome. Just open a pull request and we will review.
-If adding a model in the extended list, leave the ID field empty as it is automatically added.
+Please consider whether the model applies to be added.