beginning doc updates for version 1.2.0

sonofeft · Mar 23, 2024 · 1cf3e1c · 1cf3e1c
1 parent 7ef2c5b
commit 1cf3e1c
Show file tree

Hide file tree

Showing 75 changed files with 739 additions and 282 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -6,6 +6,59 @@ History
 
 GitHub Log
 ----------
+
+* Mar 16, 2024
+    - (by: Charlie)
+        - Try to solve ReadTheDocs problem
+        - some fixes and doc updates for numpy.distutils deprecation
+
+* Mar 5, 2024
+    - (by: Charlie)
+        - removed "import imp" from tests for "__main__" testing
+        - remove "future" from requirements
+
+* Feb 25, 2024
+    - (by: Charlie)
+        - rebuilt docs
+
+* Feb 24, 2024
+    - (by: Charlie)
+        - Rebase to edited v1.1.34 to v1.1.35
+
+* Feb 16, 2024
+    - (by: Charlie)
+        - Removed __future__ as a requirement
+
+* Dec 29, 2023
+    - (by: Charlie)
+        - Merge branch 'master' of https://github.com/sonofeft/RocketCEA
+        - added version tags
+
+* Nov 14, 2023
+    - (by: Eligh)
+        - Fixed Pinj_over_Pcomb by adding unit converasion
+        - implimented get_Pinj_over_Pcomb in cea_obj_w_units
+
+* Jul 4, 2023
+    - (by: Charlie)
+        - doc rebuild
+        - fixed transport property FORTRAN error (makeOutput flag)
+
+* Jun 28, 2023
+    - (by: Charlie)
+        - fix add_dll_directory
+        - docs updata
+        - rebuild docs
+        - static build problem on Ubuntu
+        - lament readthedocs for now
+        - try to fix readthedocs
+        - try to fix readthedocs automodule
+        - rebuilt docs
+        - version update
+        - some build cleanup
+        - set language flag to english in conf.py
+        - added frozen flags to some functions
+
 * May 3, 2023
     - (by: Charlie and Alex)
         - Added missing arguments to member functions of cea_obj_w_units

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -8,6 +8,7 @@ include thermo.*
 include trans.*
 include setup.cfg
 include .travis.yml tox.ini
+include meson.build
 
 graft rocketcea
 recursive-include rocketcea/examples *

diff --git a/README.rst b/README.rst
@@ -1,7 +1,7 @@
 
 .. image:: https://img.shields.io/pypi/v/RocketCEA.svg
 
-.. image:: https://img.shields.io/badge/python-3.7|3.8|3.9|3.10|3.11-blue
+.. image:: https://img.shields.io/badge/python-3.7|3.8|3.9|3.10|3.11|3.12-blue
 
 .. image:: https://img.shields.io/pypi/l/RocketCEA.svg
 

diff --git a/UPLOAD_TO_PyPI.BAT b/UPLOAD_TO_PyPI.BAT
@@ -1,17 +1,45 @@
 
-SET "MYPYTHONPATH=C:\Python310" 
-set PATH=C:\MinGW\mingw64\bin;C:\MinGW\mingw64\lib;%MYPYTHONPATH%;%MYPYTHONPATH%\Scripts;C:\Windows\System32
 
-cd .\docs
-C:\Python310\Scripts\sphinx-build.exe -b html -d _build/doctrees  . _build/html
-cd ..
+@echo off
+setlocal
 
-xcopy /S .\docs\_build\html .\rocketcea\sphinx_html /y
+rem Change "do_the_upload=FALSE" to "do_the_upload=TRUE" to run the upload
+rem AFTER... satisfying upload check list
+set "do_the_upload=FALSE"
 
-python setup.py sdist
+if "%do_the_upload%" == "TRUE" (
+    echo ...............................................................
+    echo doing the upload
+    echo ...............................................................
+    C:\Python310\Scripts\twine.exe upload --config-file "%HOMEPATh%\.pypirc" --skip-existing dist/*.*
+    echo ....................... DONE ..................................
+) else (
+    echo ...................... CHECK LIST .............................
+    echo ...............................................................
+    echo Install from local source afer all changes made
+    echo pip install .
+    echo ...............................................................
+    echo RUN pytest
+    echo ...............................................................
+    echo Update HISTORY.rst    README.rst    AUTHORS.rst
+    echo ...............................................................
+    echo Make sure that sphinx HTML is built with _BUILD_SPHINX_HTML.BAT
+    echo ...............................................................
+    echo COMMIT all files in git
+    echo ...............................................................
+    echo Make sure that "python -m build" has been executed
+    echo        AND any "python -m build --wheel"
+    echo ...............................................................
+    echo Run "twine check" to see if long description will render correctly
+    echo twine check dist/*            OR 
+    echo twine check dist/*24.tar.gz (where: 24 is current version)
+    echo ...............................................................
+    echo THEN: set "do_the_upload=TRUE" to run the upload
+    echo AFTER UPLOAD: set "do_the_upload=FALSE"
+    echo ...............................................................
+)
+
+endlocal
 
-rem only upload source to PyPI
-rem C:\Python310\Scripts\twine.exe upload --skip-existing dist/*.gz
-C:\Python310\Scripts\twine.exe upload --config-file "%HOMEPATh%\.pypirc" --skip-existing dist/*.*
 
 rem use:  twine check dist/*  OR twine check dist/*24.tar.gz (where: 24 is current version)
diff --git a/UPLOAD_TO_TestPyPI.BAT b/UPLOAD_TO_TestPyPI.BAT
@@ -1,15 +1,52 @@
 
-SET "MYPYTHONPATH=C:\Python310" 
-set PATH=C:\MinGW\mingw64\bin;C:\MinGW\mingw64\lib;%MYPYTHONPATH%;%MYPYTHONPATH%\Scripts;C:\Windows\System32
 
-cd .\docs
-C:\Python310\Scripts\sphinx-build.exe -b html -d _build/doctrees  . _build/html
-cd ..
 
-xcopy /S .\docs\_build\html .\rocketcea\sphinx_html /y
+@echo off
+setlocal
+
+rem Change "do_the_upload=FALSE" to "do_the_upload=TRUE" to run the upload
+rem AFTER... satisfying upload check list
+set "do_the_upload=FALSE"
+
+if "%do_the_upload%" == "TRUE" (
+    echo ...............................................................
+    echo doing the upload
+    echo NOTE: twine on WSL Ubuntu works MUCH better with testpypi
+    echo twine upload --config-file "/mnt/c/Users/Charlie Taylor/.pypirc"  --repository testpypi --skip-existing dist/*.*
+    echo ...............................................................
+    C:\Python310\Scripts\twine.exe upload --config-file "%HOMEPATh%\.pypirc" --repository testpypi --skip-existing dist/*.*
+    echo ....................... DONE ..................................
+) else (
+    echo ...................... CHECK LIST .............................
+    echo ...............................................................
+    echo Install from local source afer all changes made
+    echo pip install .
+    echo ...............................................................
+    echo RUN pytest
+    echo ...............................................................
+    echo Make sure that sphinx HTML is built with _BUILD_SPHINX_HTML.BAT
+    echo ...............................................................
+    echo COMMIT all files in git
+    echo ...............................................................
+    echo Make sure that "python -m build" has been executed
+    echo        AND any "python -m build --wheel"
+    echo ...............................................................
+    echo Run "twine check" to see if long description will render correctly
+    echo twine check dist/*            OR 
+    echo twine check dist/*24.tar.gz (where: 24 is current version)
+    echo ...............................................................
+    echo THEN: set "do_the_upload=TRUE" to run the upload
+    echo AFTER UPLOAD: set "do_the_upload=FALSE"
+    echo ...............................................................
+)
+
+endlocal
+
 
-python setup.py sdist
 
 rem only upload source to PyPI
 rem twine upload --repository testpypi --skip-existing dist/*.gz
-C:\Python310\Scripts\twine.exe upload --config-file "%HOMEPATh%\.pypirc" --repository testpypi --skip-existing dist/*.*
+
+
+rem To install from testpypi
+rem  python -m pip install --index-url https://test.pypi.org/simple/ rocketcea
diff --git a/_BUILD_SPHINX_HTML.BAT b/_BUILD_SPHINX_HTML.BAT
@@ -0,0 +1,10 @@
+
+SET "MYPYTHONPATH=C:\Python310" 
+set PATH=C:\MinGW\mingw64\bin;C:\MinGW\mingw64\lib;%MYPYTHONPATH%;%MYPYTHONPATH%\Scripts;C:\Windows\System32
+
+cd .\docs
+C:\Python310\Scripts\sphinx-build.exe -b html -d _build/doctrees  . _build/html
+cd ..
+
+xcopy /S .\docs\_build\html .\rocketcea\sphinx_html /y
+
diff --git a/_BUILD_WINDOWS_WHEEL.TXT → backup/_BUILD_WINDOWS_WHEEL.TXT b/_BUILD_WINDOWS_WHEEL.TXT → backup/_BUILD_WINDOWS_WHEEL.TXT
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/history.doctree b/docs/_build/doctrees/history.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/quickstart.doctree b/docs/_build/doctrees/quickstart.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d2e021ca77729caddf416d81c7823162
+config: 3df446543e1e9916192bcea99457df48
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_sources/quickstart.rst.txt b/docs/_build/html/_sources/quickstart.rst.txt
@@ -5,7 +5,11 @@ QuickStart
 ==========
 .. note::
 
-    On Windows, 32 bit python 3.8 and above are not supported.
+    RocketCEA on Windows has become much easier for versions 1.2.0 and above.
+
+    The deprecation of numpy.distutils forced a FORTRAN build conversion to `meson <https://mesonbuild.com/>`_ 
+    that has turned out to be a nice improvement. (Many thanks to `joel-martin <https://github.com/joel-martin>`_ for 
+    critical help with that conversion.)
 
 For a Windows install, jump straight to :ref:`link_windows_bat_file`
 
@@ -410,7 +414,7 @@ Colab plots work with RocketCEA as well.
 .. _link_windows_wsl:
 
 Windows 10 or 11 with WSL
--------------------
+-------------------------
 
 RocketCEA can also be installed on `Windows Subsystem for Linux (WSL) <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`_
 

diff --git a/docs/_build/html/_static/bizstyle.js b/docs/_build/html/_static/bizstyle.js
@@ -23,7 +23,7 @@ const initialiseBizStyle = () => {
 }
 
 window.addEventListener("resize",
-  () => (document.querySelector("li.nav-item-0 a").innerText = (window.innerWidth <= 776) ? "Top" : "RocketCEA v1.1.35 documentation")
+  () => (document.querySelector("li.nav-item-0 a").innerText = (window.innerWidth <= 776) ? "Top" : "RocketCEA v1.2.0 documentation")
 )
 
 if (document.readyState !== "loading") initialiseBizStyle()

diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: 'v1.1.35',
+    VERSION: 'v1.2.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/_build/html/ambient_isp.html b/docs/_build/html/ambient_isp.html
@@ -7,7 +7,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Ambient Isp &#8212; RocketCEA v1.1.35 documentation</title>
+    <title>Ambient Isp &#8212; RocketCEA v1.2.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/bizstyle.css" />
 
@@ -40,7 +40,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="plot_examples.html" title="Plot Examples"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.1.35 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.2.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Ambient Isp</a></li> 
       </ul>
     </div>  
@@ -307,7 +307,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="plot_examples.html" title="Plot Examples"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.1.35 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.2.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Ambient Isp</a></li> 
       </ul>
     </div>

diff --git a/docs/_build/html/authors.html b/docs/_build/html/authors.html
@@ -7,7 +7,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Authors &#8212; RocketCEA v1.1.35 documentation</title>
+    <title>Authors &#8212; RocketCEA v1.2.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/bizstyle.css" />
 
@@ -40,7 +40,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="copyright.html" title="Copyright"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.1.35 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.2.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Authors</a></li> 
       </ul>
     </div>  
@@ -189,7 +189,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="copyright.html" title="Copyright"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.1.35 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.2.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Authors</a></li> 
       </ul>
     </div>

diff --git a/docs/_build/html/copyright.html b/docs/_build/html/copyright.html
@@ -7,7 +7,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Copyright &#8212; RocketCEA v1.1.35 documentation</title>
+    <title>Copyright &#8212; RocketCEA v1.2.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/bizstyle.css" />
 
@@ -40,7 +40,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="functions.html" title="RocketCEA Functions"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.1.35 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.2.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Copyright</a></li> 
       </ul>
     </div>  
@@ -832,7 +832,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="functions.html" title="RocketCEA Functions"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.1.35 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.2.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Copyright</a></li> 
       </ul>
     </div>

diff --git a/docs/_build/html/engine_mr.html b/docs/_build/html/engine_mr.html
@@ -7,7 +7,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Engine Mixture Ratio &#8212; RocketCEA v1.1.35 documentation</title>
+    <title>Engine Mixture Ratio &#8212; RocketCEA v1.2.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/bizstyle.css" />
 
@@ -40,7 +40,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="comb_species.html" title="Species Mole Fractions"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.1.35 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.2.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Engine Mixture Ratio</a></li> 
       </ul>
     </div>  
@@ -234,7 +234,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="comb_species.html" title="Species Mole Fractions"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.1.35 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.2.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Engine Mixture Ratio</a></li> 
       </ul>
     </div>

diff --git a/docs/_build/html/functions.html b/docs/_build/html/functions.html
@@ -7,7 +7,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>RocketCEA Functions &#8212; RocketCEA v1.1.35 documentation</title>
+    <title>RocketCEA Functions &#8212; RocketCEA v1.2.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/bizstyle.css" />
 
@@ -40,7 +40,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="parasol_example.html" title="Parasol Example"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.1.35 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.2.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">RocketCEA Functions</a></li> 
       </ul>
     </div>  
@@ -1141,7 +1141,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="parasol_example.html" title="Parasol Example"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.1.35 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">RocketCEA v1.2.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">RocketCEA Functions</a></li> 
       </ul>
     </div>