{ "info": { "author": "Rob Markoski", "author_email": "software@imeconsultants.com.au", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# colebrook.py\n\n**Current Status:** Development\n\n**Version:** 20190213\n\n# TABLE OF CONTENTS\n\n- [colebrook.py](#colebrookpy)\n- [TABLE OF CONTENTS](#table-of-contents)\n - [TODO](#todo)\n - [DISCLAIMER](#disclaimer)\n - [BACKGROUND](#background)\n - [HOW TO USE](#how-to-use)\n - [USE AS MODULE](#use-as-module)\n - [USE AS STAND ALONE APPLICATION](#use-as-stand-alone-application)\n - [COLEBROOK-WHITE APPROXIMATIONS](#colebrook-white-approximations)\n - [REVISION HISTORY](#revision-history)\n\n## TODO\n\n- Add further approximation functions.\n- Add warnings for parameters outside of the range for given formula.\n\n## DISCLAIMER\n\n**No guarantee of accuracy is provided, confirm results with other sources.**\n\n## BACKGROUND\n\nThe Colebrook-White equation is used to solve for the [Darcy Friction Factor](https://en.wikipedia.org/wiki/Darcy_friction_factor_formulae) (f) for use in the determination of friction losses in pipe and open-channel flows.\n\nThe equation is expressed in terms of:\n\n| Parameters | Description \n|---|---|\n| [Reynolds Number](https://en.wikipedia.org/wiki/Reynolds_number) | A dimensionless value that describes the type of flow - As per | \n| Pipe Relative Roughness | A value which describes the roughness of the pipe material compared to its inner diameter. \n\nThis module implements various approximations of the function for use in pipe flow calculations.\n\n## HOW TO USE\n\n### USE AS MODULE\n\nEach approximation takes the Reynolds Number and Relative Roughness as required arguments, with the number of significant figures as an optional argument, in the format of ```function(reynolds, relative roughness, signficant figures)```\n\nFor example:\n\n```python\n import colebrook\n factor = colebrook.sjFriction( 60000, 0.0023)\n print(factor)\n```\n\nWhich outputs\n\n```python\n 0.027\n```\n\n### USE AS STAND ALONE APPLICATION\n\nThere is also limited ability to run the script from the command line. The script will run against all available functions.\n\n```console\npython colebrook.py [Optional Significant figures]\n$ python colebrook.py 60000 0.0023\nEnsure values are within range of applicability for equations (specifically around transition and laminar region)!\n|METHOD | VALUE |\n---------------------------\n|sjFriction | 0.027 |\n|bntFriction | 0.0203 |\n|fngFriction | 0.0267 |\n|akFriction | 0.0262 |\n|bkcFriction | 0.0271 |\n|eptFriction | 0.0269 |\nDISCLAIMER: Use secondary verification. No guarantee of accuracy\n```\n\n## COLEBROOK-WHITE APPROXIMATIONS\n\nThe following functions are available in this module. They have been adapted from the Wikipedia [Darcy Friction Factor Formulae Table of Approximation](https://en.wikipedia.org/wiki/Darcy_friction_factor_formulae#Table_of_Approximations) page.\n\n|FUNCTIONAME|AUTHOR|YEAR| VALIDITY RANGE|REF|\n|-|-|-|-|-|\n| sjFriction() | Swamee and Jain | 1976 | Re= 5000 to 10^8 and e/D = 0.00001 - 0.05| [Paper](https://cedb.asce.org/CEDBsearch/record.jsp?dockey=0006693) |\n| btnFriction() | Bellos, Nalbantis, Tsarkris | 2018 | All Flow Regimes | [Paper](https://ascelibrary.org/doi/10.1061/%28ASCE%29HY.1943-7900.0001540) |\n| fngFriction() | Fang et al. | 2011 | R>=2300 | [Paper](https://www.sciencedirect.com/science/article/pii/S0029549311000173) |\n| eptFriction() | Evangelides, Papaevangelou, Tzimopoulos | 2010 | R>=2300 | [Paper](http://blogs.sch.gr/geopapaevan/files/2010/07/full-paper_pre1128act.pdf) |\n| akFriction() | Avci, Kargoz | 2009 | R>=2300| [Paper](http://dx.doi.org/10.1115/1.3129132) |\n| bkcFriction() | Brkic | 2011 | R>=2300 | [Paper](https://doi.org/10.1080%2F10916461003620453) |\n\n## REVISION HISTORY\n| REVISION | DESCRIPTION |\n| -- | -- |\n| 20190213 | Initial Development Version |\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/IMEConsultants/colebrook/", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "colebrook", "package_url": "https://pypi.org/project/colebrook/", "platform": "", "project_url": "https://pypi.org/project/colebrook/", "project_urls": { "Homepage": "https://github.com/IMEConsultants/colebrook/" }, "release_url": "https://pypi.org/project/colebrook/0.0.5/", "requires_dist": null, "requires_python": "", "summary": "A small module that calculate colebrook-white approximations", "version": "0.0.5" }, "last_serial": 4881899, "releases": { "0.0.5": [ { "comment_text": "", "digests": { "md5": "12b21832b450320f79436ada1ac6ecd2", "sha256": "616145dc06f39629955d5add489f1818576aaa34bb56adad2f8a11bc2466856c" }, "downloads": -1, "filename": "colebrook-0.0.5-py3-none-any.whl", "has_sig": false, "md5_digest": "12b21832b450320f79436ada1ac6ecd2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 17406, "upload_time": "2019-03-01T01:49:52", "url": "https://files.pythonhosted.org/packages/2c/53/d8b7fe8e64221abd95aa3a6ac04d0212fa3907edec4ff6e2935ac273f4be/colebrook-0.0.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "511e14ef396f9cba6beebdbadf572dfc", "sha256": "847f2ef90f9a2d612b4ce2211187faa3f4a11ce40af271e98192340df5aab487" }, "downloads": -1, "filename": "colebrook-0.0.5.tar.gz", "has_sig": false, "md5_digest": "511e14ef396f9cba6beebdbadf572dfc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4350, "upload_time": "2019-03-01T01:49:54", "url": "https://files.pythonhosted.org/packages/db/17/cc7125ca8305f5ab7affcf9ad387c560d9bb2a726b29c37f8ce1e1a1825e/colebrook-0.0.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "12b21832b450320f79436ada1ac6ecd2", "sha256": "616145dc06f39629955d5add489f1818576aaa34bb56adad2f8a11bc2466856c" }, "downloads": -1, "filename": "colebrook-0.0.5-py3-none-any.whl", "has_sig": false, "md5_digest": "12b21832b450320f79436ada1ac6ecd2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 17406, "upload_time": "2019-03-01T01:49:52", "url": "https://files.pythonhosted.org/packages/2c/53/d8b7fe8e64221abd95aa3a6ac04d0212fa3907edec4ff6e2935ac273f4be/colebrook-0.0.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "511e14ef396f9cba6beebdbadf572dfc", "sha256": "847f2ef90f9a2d612b4ce2211187faa3f4a11ce40af271e98192340df5aab487" }, "downloads": -1, "filename": "colebrook-0.0.5.tar.gz", "has_sig": false, "md5_digest": "511e14ef396f9cba6beebdbadf572dfc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4350, "upload_time": "2019-03-01T01:49:54", "url": "https://files.pythonhosted.org/packages/db/17/cc7125ca8305f5ab7affcf9ad387c560d9bb2a726b29c37f8ce1e1a1825e/colebrook-0.0.5.tar.gz" } ] }