First commit of the first working public release version 0.1a9

Intially had diffuclty releasing the package and had to make
multiple releases to things right
Ran into issues with PYPI
Issue 1 Rendering the Readme.md file infile links properly
        Could not fix this and removed all links
Issue 2 Distributing .txt data files along with .py files
        After trying many suggestions from forums added
        MANIFEST file and couple of lines to setup.py
        Added .gitignore to consolidate PYPI release within the
        main pychemengg working folder
Cleaning up these issues on PYPI led to unnecessary releases
becase PYPI does not allow swapping files out without creating
new releases
Issue 3 Sphinx documentation did not compile on RTD although
        it works locally on PC
        Finally decision was made to instead host on GitHub Pages

.gitignore

@@ -0,0 +1,139 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+Readme.md
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

License.txt

@@ -0,0 +1,22 @@
+PyChemEngg: A python-based framework to promote problem solving and critical
+thinking in chemical engineering.
+
+Copyright (c) 2021 Harvinder Singh Gill <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1 @@
+recursive-include pychemengg/physicalproperties *.txt

Readme.rst

@@ -0,0 +1,133 @@
+
+PyChemEngg
+==========
+
+.. contents::
+
+About PyChemEngg
+-----------------
+
+PyChemEngg is a python-based framework to promote problem solving and critical
+thinking in chemical engineering.
+
+Computers have changed every aspect of human life, and exciting advancements
+in quantum computing, articial intelligence and other revolutionary technologies
+are expected to make computational thinking even more integral to the work space.
+
+To better prepare the future generations of chemical engineers, it is important
+to therefore incorporate a greater degree of computational thinking in their
+education. This however, should not mean that students instead of using
+calculators should start coding and translating mathematical equations and formula
+into a program using a software language. Doing so will not enhance engineering
+thinking. Instead, the computational tools should be used to reinforce concepts,
+and train the students in problem solving. 
+
+One way to do this is to use a framework that encapsulates the equations and formula
+into words, and allows use of these words to build solutions. PyChemEngg strives to
+do just that.
+
+
+Philosophy
+----------
+
+The *PyChemEngg* package has the following philosophy:
+
+The package should facilitate student learning. The package should not
+become a black box such that it hides the underlying fundamentals of
+chemical engineering. Instead the package should reinforce chemical
+engineering principles, and stimulate students to think.
+
+In keeping with the above philosophy and for making learning intuitive,
+symbolism has been avoided and the public API contains only
+**keyword arguments**, and the names of the **keywords** have been kept as close
+as possible to their corresponding descriptive names of concepts and
+quantities.
+
+The expectation is that use of *words* rather than symbols will
+reinforce concepts and promote deeper learning and thinking.
+
+
+Why use Python to make this framework ?
+----------------------------------------
+
+Python is known for its simple syntax, English-like commands, and ease of learning.
+Python also has a mature ecosystem with respect to support libraries and packages
+such as numpy, scipy, and matplotlib, which can provide a comprehensive support
+in developing such as framework. Therefore, Python is a natural choice for
+developing this framework, and thus the idea of **PyChemEngg** was born.
+
+An additional benefit of Python is its popularity in scientific and technical
+computational areas such as artifical intelligence, machine learning, and data science.
+Therefore, by using Python, the future generation of chemical engineers will be able
+learn Python, a skill that is already in demand in the industry. This will make the
+chemical engineers even more versatile.
+
+
+Documentation and examples
+----------------------------
+
+https://profhsgill.github.io/pychemengg/build/html/index.html
+
+
+How to install PyChemEngg
+--------------------------
+
+PyChemEngg can be installed using pip : ``pip install pychemengg``
+
+
+
+Project status
+---------------
+
+PyChemEngg is in a state of development and evolution. In the near future,
+there will be support for different topics such as:
+
+* Material Balances
+* Heat Transfer
+* Fluid Flow
+* Thermodynamics
+* Chemical Reaction Engineering
+* Process Control
+
+At this time the following has been accomplished.
+
+1. Material Balances : Physical balance module is ready and is being documented.
+2. Heat Transfer : Modules for common topics generally taught are ready and released as a beta version.
+
+
+To do
+-----
+
+1. Finish the 'transition heat transfer' module for heat transfer and add it to the package.
+2. Complete 'tutorial' on material balances (without chemical reaction) and release the module.
+3. Gather feedback from constituents (instructors and students) to revise the design.
+
+
+Issues
+-------
+
+Please report at:
+
+https://github.com/profhsgill/pychemengg/issues
+
+
+Website for Python installation
+--------------------------------
+PyChemEngg is hosted at :
+
+    https://pypi.org/project/pychemengg/
+
+
+
+Contact
+--------
+Created by [ [email protected] ] (http://www.gilllab.science), feel free to contact me.
+
+Suggestions are welcome.
+
+
+
+License information
+-------------------
+PyChemEngg is open source and is available under the MIT license (read License.txt).
+

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/index.html

@@ -0,0 +1 @@
+<meta http-equiv="refresh" content="0; url=build/html/index.html" />

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/_autosummary/pychemengg.heattransfer.externalflow.Cylinder.rst

@@ -0,0 +1,29 @@
+Cylinder
+========
+
+.. currentmodule:: pychemengg.heattransfer.externalflow
+
+.. autoclass:: Cylinder
+   :members:                                   
+   :show-inheritance:                           
+   :inherited-members:                          
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Cylinder.Nu_churchill_bernstein
+      ~Cylinder.Nu_hilpert_knudsen_katz
+      ~Cylinder.__init__
+
+
+
+
+
+
+
+