More dir struct

Docs/Format description.md

@@ -0,0 +1,61 @@
+# Format for CRZ PERF tables
+
+Columns delimited with `;`
+
+First column is altitude
+
+Second column is FF per engine in kg/hr
+-  Column contains values for weights ranging from 140t to 290t in 10t increments
+-  Delimited with `,`
+
+Third column is IAS
+-  If single value, apply to all weights
+-  If multiple values, apply to respective weights (delimited with `,`)
+ 
+Fourth column is MACH
+-  If single value, apply to all weights
+-  If multiple values, apply to respective weights (delimited with `,`)
+
+# Format for ECON tables
+2d matrix of mach values
+
+Columns delimited with `,` \
+One file per altitude and MMO combination
+
+First index is weight (equates to the lines in the file)
+- Must be of 140, 150, 160, 170, 180, 190, 200, 210, 220, 230, 240, 250, 260, 270, 280, or 290
+  
+Second index is CI (equates to the columns in a line)
+- Must be in range $[0, 999]$
+  
+# Format for raw curve tables
+2d matrix of curve parameters
+
+Columns delimited with `;` \
+Parameters delimited with `,`, ordered $a, b, c$
+
+First index is altitude (equates to lines in the file)
+- Must be of 250, 270, 290, 310, 330, 350, 370, 390, 410, or 430
+
+Second index is weight (equates to the columns in a line)
+- Must be of 140, 150, 160, 170, 180, 190, 200, 210, 220, 230, 240, 250, 260, 270, 280, or 290
+
+#### Usage of function
+$$
+  f(x) = a \cdot \sqrt x + b \cdot x + c
+$$
+Extract parameters $a,b,c$ from the table \
+$x$ is the CI and must be in range $[0,999]$ \
+$f(x)$ is the mach number for the given altitude, weight, CI, and MMO
+
+# Conversion of weight to index
+
+$$f(x) = \frac{x - 140}{10}$$
+$x$ is weight (see range restrictions where applicable)\
+$f(x)$ is the resulting index for the LUTs
+
+# Conversion of altitude to index
+
+$$f(x) = \frac{x - 250}{20}$$
+$x$ is altitude (see range restrictions where applicable)\
+$f(x)$ is the resulting index for the LUTs