Code Monkey home page Code Monkey logo

aerocalc's Introduction

Welcome to aerocalc3 โœˆ๏ธ๐Ÿงฎ documentation

Netlify Status

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

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
  1. Activate the environent. For Linux/MacOS users use the command below
source venv/bin/activate

for windows users

cd venv/Scripts

activate.bat
  1. Install the requirements
pip install -r requirements.txt
  1. 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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.