============
Introduction
============
pyAPP6 is a Python package to interact with ALR's Aircraft Performance Program APP.

The current implementation of pyAPP6 is a file based interface to APP. pyAPP6's classes enable to read and write 
APP6 files. Together with the command line interface of APP, pyAPP6 allows for automation of mission and point 
performance computations. The results that are calculated and written by APP (as text files) can be read with pyAPP6.

.. image:: images/schema.png

============
Installation
============

If you do not already have a Python distribution installed, ALR recommends to use a distribution that is pre-built for windows and 
includes common modules such as numpy, scipy and matplotlib. Such a distribution is Anaconda, available here:
https://www.continuum.io/downloads

Installing pyAPP6 is straight forward, as for any python packge. Navigate to the pyAPP6 folder and open a Windows command 
line (cmd). Install pyAPP6 by executing::

    python setup.py install

This will add pyAPP6 to your active python distribution. To test the sucessful installation, open a python shell by entering::

    python
    
and then type::

    >>> import pyAPP6
    
If no error message appears, the installation was sucessful.

A second method is to either add the path to the pyAPP6 root folder in each script by modifying sys.path or to add the
path to the PYTHONPATH environment variable. For futher information, consult the official python documentation
on how to install modules: https://docs.python.org/2/install/#modifying-python-s-search-path

================
APP Command Line
================

APP6 offers a command line mode to execute a computation without using the Graphical User Interface (GUI).
pyAPP6 has two classes that simplify the execution of APP from a Python script.

The command line mode of APP6 writes the results in ASCII format into a text file (.txt). This file can then be read by
pyAPP6.

To calculate a mission saved as myMission.mis, type: 

::

   App6.exe -m myMission.mis

To calculate a Performance Chart saved as myChart.perf, type: 
   
::

   App6.exe -pp myChart.perf

=======
Authors
=======

ALR-Aerospace:

- Marc Immer
- Micha Brunner
- Philipp Juretzko