geoffreynyaga / aerocalc

aerocalc that supports python3

Welcome to aerocalc3 ✈️🧮 documentation

aerocalc3 Aeronautical Engineering Calculations

aerocalc3 is a python utility package that performs various aeronautical engineering calculations.

Currently it provides:

• airspeed conversions,
• static source error correction calculations
• standard atmosphere calculations and
• unit conversions.

Full Documentation

• Homepage: https://aerocalc3.netlify.com
• pypi website: https://pypi.org/project/aerocalc3/

GitHub Pages

Table of Contents

Airspeed Conversions Docs ↗️

Default Values Docs ↗️

Physical Properties (density, pressure etc) Conversion Docs ↗️

Original aerocalc:

For original documentation visit kilohotel

Installation 📥

pip install aerocalc3==0.10

Alternatively:

Download the files https://github.com/geoffreynyaga/aerocalc/archive/v_01.tar.gz, decompress it and use setup.py to install.

wget https://github.com/geoffreynyaga/aerocalc/archive/v_01.tar.gz

tar xf v0.11-py3.tar.gz

cd aerocalc-0.11-py3

python setup.py install

Project layout

    .
    ├── aerocalc # Source code folder.
    │   └── tests
    ├── docs # The documentation directory.
    ├── htmlcov # Test coverage folder.
    ├── site # Documentation build for deployment.
    │   ├── about
    │   ├── css
    │   ├── fonts
    │   ├── img
    │   ├── js
    │   └── search
    └── venv # Your generated virtual environment.

Testing 🧪🧪

The projects uses pytest and black as the formatting option. The tests also check for consistencies on code format.

To initiate tests follow the steps below:

1. Its advised to create a virtual environment

virtualenv venv

2. Activate the environent. For Linux/MacOS users use the command below

source venv/bin/activate

for windows users

cd venv/Scripts

activate.bat

3. Install the requirements

pip install -r requirements.txt

4. Run the pytest command

pytest

The testing results will be displayed and there will also be a htmlcov folder generated inside the project that will contain the code coverage details.

├── aerocalc3
│   ├── __pycache__
│   └── test
├──  htmlcov
└── venv

Open up the folder and open the index.html in your browser to see this information.