Metadata-Version: 2.0
Name: caeroc
Version: 0.0.2b2
Summary: Compressible aerodynamics calculator in Python
Home-page: https://github.org/jadelord/caeroc
Author: Ashwin Vishnu Mohanan
Author-email: avmo@kth.se
License: GPL
Description-Content-Type: UNKNOWN
Keywords: compressible aerodynamics,calculator,gas dynamics
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: scikit-aero (>=0.2.dev0)
Provides-Extra: pyqt
Requires-Dist: PyQt5; extra == 'pyqt'
Provides-Extra: pyside
Requires-Dist: PySide; extra == 'pyside'

|version| |LICENSE| |travis|

A python package for compressible flows. A dynamic toolkit which enables
you to make use of the formulae governing compressible flows.

Requirements
------------
- Python 2.7, >=3.4
- pylab (numpy, scipy and matplotlib)
- ashwinvis/scikit-aero >= 0.2
- PyQt5 / PySide (optional, but recommended for GUI)
- pandas (optional: for making tables)
- colorlog (optional: for coloured log)

Installation
------------
To install from PyPI:

.. code:: bash

    pip install -e git+https://github.com/ashwinvis/scikit-aero.git#egg=scikit-aero

    # Any of the following
    pip install caeroc
    pip install caeroc[pyqt]
    pip install caeroc[pyside]

To install development versions of ``caeroc`` and ``scikit-aero``

.. code:: bash

    pip install -e git+https://github.com/ashwinvis/caeroc.git#egg=caeroc --process-dependency-links --trusted-host github.com

If the current configuration of the GUI does not work for you,
regenerate it by running:

.. code:: bash

    cd caeroc/gui
    ./configure

Launch
------
Simply run in your terminal

.. code:: bash

    caeroc-app

Development
-----------

Development mode will install ``caeroc`` using soft links.

.. code:: bash

    git clone --recursive https://github.com/ashwinvis/caeroc.git
    cd caeroc
    python setup.py develop
    cd ../scikit-aero
    python setup.py develop

Features
--------

-  [x] Command-line tool which opens a Qt based GUI calculator

.. figure:: http://i.imgur.com/7Bb0ypN.png
   :alt: In development

   In development

-  [ ] Save data as a database
-  [ ] Plotting graphs
-  [ ] Generate gas tables
-  [ ] Calculate flow characteristics: Coefficient of pressure, lift and
   drag for basic profiles.

Courtesy
--------

-  The idea for a compressible aerodynamics calculator in the form an
   online JS tool had been implemented by `William
   Devenport <http://www.aoe.vt.edu/people/faculty.php?fac_id=wdevenpo>`__
   `here <http://www.dept.aoe.vt.edu/~devenpor/aoe3114/calc.html>`__.
   This project is pushing more functionalities as an offline tool and
   allowing users to dynamically use the formulae for specific cases.
-  Thanks to the scikit-aero team for being the backend

.. |version| image:: https://img.shields.io/pypi/v/caeroc.svg
   :target: https://pypi.python.org/pypi/caeroc/
   :alt: Latest version
.. |LICENSE| image:: https://img.shields.io/badge/license-GPL-blue.svg
   :target: /LICENSE
.. |travis| image:: https://travis-ci.org/ashwinvis/caeroc.svg?branch=master
   :target: https://travis-ci.org/ashwinvis/caeroc


