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.
- Homepage: https://aerocalc3.netlify.com
- pypi website: https://pypi.org/project/aerocalc3/
Table of Contents
Airspeed Conversions 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:
- Its advised to create a virtual environment
virtualenv venv
- Activate the environent. For Linux/MacOS users use the command below
source venv/bin/activate
for windows users
cd venv/Scripts
activate.bat
- Install the requirements
pip install -r requirements.txt
- 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.