caeroc


Namecaeroc JSON
Version 0.0.3b1 PyPI version JSON
download
home_pageNone
SummaryCompressible aerodynamics calculator in Python
upload_time2024-11-21 17:07:47
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseGPL
keywords calculator compressible aerodynamics gas dynamics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            caeroc
======

Compressible Aerodynamics Calculator for Python
-----------------------------------------------

|version| |LICENSE| |travis|

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

.. figure:: https://raw.githubusercontent.com/ashwinvis/caeroc/gh-pages/screenshot.png
   :alt: Screenshot

.. figure:: https://raw.githubusercontent.com/ashwinvis/caeroc/gh-pages/caeroc-video.png
   :alt: Demo. Click to see the full video
   :align: right
   :target: https://tube.tchncs.de/w/21xYGCA4DDzkaeFKwq6Gy5

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

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

.. code:: bash

    # 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 'caeroc[pyqt] @ https://github.com/ashwinvis/caeroc/archive/main.zip'
    # or
    pip install 'caeroc[pyside] @ https://github.com/ashwinvis/caeroc/archive/main.zip'

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

Features
--------

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

   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 <https://www.aoe.vt.edu/people/faculty/devenport.html>`__
   `here <https://web.archive.org/web/20221106025044/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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "caeroc",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "calculator, compressible aerodynamics, gas dynamics",
    "author": null,
    "author_email": "\"Ashwin V. Mohanan\" <dev@fluid.quest>",
    "download_url": "https://files.pythonhosted.org/packages/78/90/ed7fd1eae43be8b139526e323d10aa2069040cbf3f8ba41db1e27ae3f144/caeroc-0.0.3b1.tar.gz",
    "platform": null,
    "description": "caeroc\n======\n\nCompressible Aerodynamics Calculator for Python\n-----------------------------------------------\n\n|version| |LICENSE| |travis|\n\nA python package for compressible flows. A dynamic toolkit which enables\nyou to make use of the formulae governing compressible flows.\n\n.. figure:: https://raw.githubusercontent.com/ashwinvis/caeroc/gh-pages/screenshot.png\n   :alt: Screenshot\n\n.. figure:: https://raw.githubusercontent.com/ashwinvis/caeroc/gh-pages/caeroc-video.png\n   :alt: Demo. Click to see the full video\n   :align: right\n   :target: https://tube.tchncs.de/w/21xYGCA4DDzkaeFKwq6Gy5\n\nRequirements\n------------\n- Python 3.10\n- pylab (numpy, scipy and matplotlib)\n- scikit-aero >= 0.2\n- PyQt5 / PySide2 (optional, but recommended for GUI)\n- pandas (optional: for making tables)\n- colorlog (optional: for coloured log)\n\nInstallation\n------------\nTo install from PyPI:\n\n.. code:: bash\n\n    # Any of the following\n    pip install caeroc\n    pip install caeroc[pyqt]\n    pip install caeroc[pyside]\n\nTo install development versions of ``caeroc`` and ``scikit-aero``\n\n.. code:: bash\n\n    pip install 'caeroc[pyqt] @ https://github.com/ashwinvis/caeroc/archive/main.zip'\n    # or\n    pip install 'caeroc[pyside] @ https://github.com/ashwinvis/caeroc/archive/main.zip'\n\nIf the current configuration of the GUI does not work for you,\nregenerate it by running:\n\n.. code:: bash\n\n    cd caeroc/gui\n    ./configure\n\nLaunch\n------\nSimply run in your terminal\n\n.. code:: bash\n\n    caeroc-app\n\nFeatures\n--------\n\n-  [x] Command-line tool which opens a Qt based GUI calculator\n\n   In development\n\n-  [ ] Save data as a database\n-  [ ] Plotting graphs\n-  [ ] Generate gas tables\n-  [ ] Calculate flow characteristics: Coefficient of pressure, lift and\n   drag for basic profiles.\n\nCourtesy\n--------\n\n-  The idea for a compressible aerodynamics calculator in the form an\n   online JS tool had been implemented by `William\n   Devenport <https://www.aoe.vt.edu/people/faculty/devenport.html>`__\n   `here <https://web.archive.org/web/20221106025044/http://www.dept.aoe.vt.edu/~devenpor/aoe3114/calc.html>`__.\n   This project is pushing more functionalities as an offline tool and\n   allowing users to dynamically use the formulae for specific cases.\n-  Thanks to the scikit-aero team for being the backend\n\n.. |version| image:: https://img.shields.io/pypi/v/caeroc.svg\n   :target: https://pypi.python.org/pypi/caeroc/\n   :alt: Latest version\n.. |LICENSE| image:: https://img.shields.io/badge/license-GPL-blue.svg\n   :target: /LICENSE\n.. |travis| image:: https://travis-ci.org/ashwinvis/caeroc.svg?branch=master\n   :target: https://travis-ci.org/ashwinvis/caeroc\n",
    "bugtrack_url": null,
    "license": "GPL",
    "summary": "Compressible aerodynamics calculator in Python",
    "version": "0.0.3b1",
    "project_urls": {
        "Homepage": "https://github.org/ashwinvis/caeroc"
    },
    "split_keywords": [
        "calculator",
        " compressible aerodynamics",
        " gas dynamics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "327daa09bac0d08f73550239d43316993244cb972ab36bc50941148795d8a061",
                "md5": "77025cae455f77a82cded76205f051df",
                "sha256": "6ce7c80e0de8eddeb41b177b22107e1963996b41b16c2a7484f273f182894477"
            },
            "downloads": -1,
            "filename": "caeroc-0.0.3b1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "77025cae455f77a82cded76205f051df",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 45921,
            "upload_time": "2024-11-21T17:07:44",
            "upload_time_iso_8601": "2024-11-21T17:07:44.803886Z",
            "url": "https://files.pythonhosted.org/packages/32/7d/aa09bac0d08f73550239d43316993244cb972ab36bc50941148795d8a061/caeroc-0.0.3b1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7890ed7fd1eae43be8b139526e323d10aa2069040cbf3f8ba41db1e27ae3f144",
                "md5": "ad6277c4bad1346ab855e06b4b47c662",
                "sha256": "9b20f6068ea1826af0f92b752f6fca745bfa7c0ed90b71bfce8d5a4c61f400e2"
            },
            "downloads": -1,
            "filename": "caeroc-0.0.3b1.tar.gz",
            "has_sig": false,
            "md5_digest": "ad6277c4bad1346ab855e06b4b47c662",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 90336,
            "upload_time": "2024-11-21T17:07:47",
            "upload_time_iso_8601": "2024-11-21T17:07:47.237576Z",
            "url": "https://files.pythonhosted.org/packages/78/90/ed7fd1eae43be8b139526e323d10aa2069040cbf3f8ba41db1e27ae3f144/caeroc-0.0.3b1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-21 17:07:47",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "caeroc"
}
        
Elapsed time: 4.49195s