Metadata-Version: 2.1
Name: demo-orifice-calc
Version: 1.0.0
Summary: Demonstration of an orifice calculation module
Home-page: UNKNOWN
Author: Darren Hewett
Author-email: 
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Requires-Dist: scipy
Requires-Dist: math

# Demo Orifice Calculation

A simple python package containing a single-function module which calculates the orifice diameter required to acheive a given flowrate in a pipe. The calculation itself is straightforward and serves as an example of how Python libraries could be used to manage verified and tested calculations rather than using uncontrolled and untrusted spreadsheets.

## Installation

You can install this demo orifice calculation module from PyPI:

	pip install demo-orifice-calc

## How to use

The module can be imported into any python 3.x environment such as [Jupyter](https://jupyter.org/). Or, using the Python interpreter:

	>>> from demo_orifice_calc import orifice_calc
	>>> help(orifice_calc)

As a working example if we want to find the orifice diameter required to give a 1.0&nbsp;m headloss in a 300&nbsp;mm diameter pipe at 100&nbsp;L/s :

	>>> orifice_calc(0.1, 0.3, 1.0)

## Trust

In order to gain confidence in the validity of the results of calculation functions like this a test suite can be created. This demo library includes one such test which can be checked by looking for the "build | passing" icon near the top of the page on GitHub.

