Merge branch 'master' into release

LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2016, 2017, 2018, 2019, 2020, Caleb Bell <Caleb.Andrew.Bell@gmail.com>
+Copyright (C) 2016, 2017, 2018, 2019, 2020, 2021 Caleb Bell <Caleb.Andrew.Bell@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

chemicals/__init__.py

@@ -138,7 +138,7 @@
 
 chemicals_dir = utils.source_path
 
-__version__ = '0.1.5'
+__version__ = '1.0.0'
 
 def complete_lazy_loading():
     critical._load_critical_data()

docs/conf.py

@@ -48,17 +48,24 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
     'sphinx.ext.coverage',
-    'sphinx.ext.mathjax',
+    #'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
     'sphinx.ext.autosummary',
     'numpydoc',
     'IPython.sphinxext.ipython_console_highlighting',
     'IPython.sphinxext.ipython_directive',
     'sphinx.ext.intersphinx',
-]
+    'nbsphinx',
+    'matplotlib.sphinxext.plot_directive',
+    'sphinxcontrib.katex',
+    'sphinx_sitemap',
+    ]
 
 #     'sphinx.ext.napoleon'
 
+html_baseurl = 'https://chemicals.readthedocs.io/'
+sitemap_url_scheme = "{link}"
+sitemap_filename = 'sitemap2.xml' # readthedocs generates its own
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -73,18 +80,18 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'chemicals'
+project = u'Chemicals'
 import datetime
 copyright = u'2016 - %s, Caleb Bell and contributors' %datetime.datetime.now().year
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
+import chemicals
 #
-# The short X.Y version.
-version = '0.1'
+version = chemicals.__version__
 # The full version, including alpha/beta/rc tags.
-release = '0.1'
+release = chemicals.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -98,7 +105,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ['_build', '**.ipynb_checkpoints']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -295,29 +302,12 @@
 numpydoc_class_members_toctree = False
 autosummary_generate = True
 
-#autodoc_default_flags = ['members', 'private-members', 'special-members',
-#                         #'undoc-members',
-#                         'show-inheritance']
-
-#def autodoc_skip_member(app, what, name, obj, skip, options):
-#    #exclusions = ('__doc__', '__module__', '__dict__')
-#    if hasattr(obj, 'doc') and 'Chemical Engineering Design Library' in obj.doc:
-#		print(obj.__doc__, what, name)
-#    #exclude = name in exclusions
-#    #return skip or exclude
-#    return True
-
-#def setup(app):
-#    app.connect('autodoc-skip-member', autodoc_skip_member)
-
-#def maybe_skip_member(app, what, name, obj, skip,
-                                  #options):
-    #if name == 'Chemical':               
-        #print('hi3', dir(options['members']))
-        #print('hi2', app.config, dir(app.config) )        
-        #print app, what, name, obj, skip, options
-        #print(dir(app))
-    #return False
+katex_css_path = \
+    'https://cdn.jsdelivr.net/npm/katex@0.12.0/dist/katex.min.css'
+katex_js_path = \
+    'https://cdn.jsdelivr.net/npm/katex@0.12.0/dist/katex.min.js'
+katex_autorender_path = \
+    'https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.12.0/contrib/auto-render.min.js'
 
 from sphinx.ext.autodoc import between
 import chemicals

docs/robots.txt

@@ -0,0 +1,3 @@
+User-agent: *
+
+Sitemap: https://chemicals.readthedocs.io/sitemap2.xml

requirements_docs.txt

@@ -1,7 +1,13 @@
 numpy
-pandas
-numpydoc
 scipy
+numpydoc
+pint
+nbsphinx
 fluids>=1.0.0
 IPython
-pint
+ipython
+numba
+pandas
+sphinxcontrib-katex
+sphinx-sitemap
+sphinx==3.2.1

setup.py

@@ -26,7 +26,7 @@
 
 
 classifiers=[
-    'Development Status :: 3 - Alpha',
+    'Development Status :: 5 - Production/Stable',
     'Intended Audience :: Developers',
     'Intended Audience :: Education',
     'Intended Audience :: Manufacturing',
@@ -43,7 +43,10 @@
     'Programming Language :: Python :: 3',
     'Programming Language :: Python :: 3.7',
     'Programming Language :: Python :: 3.8',
+    'Programming Language :: Python :: 3.9',
+    'Programming Language :: Python :: 3.10',
     'Programming Language :: Python :: Implementation :: CPython',
+    'Programming Language :: Python :: Implementation :: PyPy',
     'Topic :: Education',
     'Topic :: Scientific/Engineering :: Atmospheric Science',
     'Topic :: Scientific/Engineering :: Chemistry',
@@ -55,28 +58,28 @@
   name = 'chemicals',
   packages = ['chemicals'],
   license='MIT',
-  version = '0.1.5',
+  version = '1.0.0',
   description = 'Chemical properties component of Chemical Engineering Design Library (ChEDL)',
   author = 'Caleb Bell',
-  install_requires=['fluids>=0.1.86', 'scipy', 'pandas'],
+  install_requires=['fluids>=1.0.0', 'scipy', 'numpy', 'pandas'],
   extras_require = {
       'Coverage documentation':  ['wsgiref>=0.1.2', 'coverage>=4.0.3']
   },
   long_description=open('README.rst').read(),
   platforms=["Windows", "Linux", "Mac OS", "Unix"],
   author_email = 'Caleb.Andrew.Bell@gmail.com',
   url = 'https://github.com/CalebBell/chemicals',
-  download_url = 'https://github.com/CalebBell/chemicals/tarball/0.1.5',
-  keywords = ['chemical engineering', 'chemistry', 'mechanical engineering', 
+  download_url = 'https://github.com/CalebBell/chemicals/tarball/1.0.0',
+  keywords = ['chemical engineering', 'chemistry', 'mechanical engineering',
   'thermodynamics', 'databases', 'cheminformatics', 'engineering','viscosity',
-  'density', 'heat capacity', 'thermal conductivity', 'surface tension', 
-  'combustion', 'environmental engineering', 'solubility', 'vapor pressure', 
+  'density', 'heat capacity', 'thermal conductivity', 'surface tension',
+  'combustion', 'environmental engineering', 'solubility', 'vapor pressure',
   'equation of state', 'molecule'],
   classifiers = classifiers,
-  package_data={'chemicals': ['Critical Properties/*', 'Density/*', 
+  package_data={'chemicals': ['Critical Properties/*', 'Density/*',
   'Electrolytes/*', 'Environment/*', 'Heat Capacity/*', 'Identifiers/*',
-  'Law/*', 'Misc/*', 'Phase Change/*', 'Reactions/*', 'Safety/*', 
-  'Solubility/*', 'Interface/*', 'Triple Properties/*', 
-  'Thermal Conductivity/*', 
+  'Law/*', 'Misc/*', 'Phase Change/*', 'Reactions/*', 'Safety/*',
+  'Solubility/*', 'Interface/*', 'Triple Properties/*',
+  'Thermal Conductivity/*',
   'Vapor Pressure/*', 'Viscosity/*']}
 )