Merge pull request #41 from Ericgig/misc.docs_fix

Fix typos in documentation example

.github/workflows/build_documentation.yml

@@ -18,16 +18,17 @@ jobs:
 
       - name: Install documentation dependencies
         run: |
-          python -mpip install -r doc/requirements.txt
+          python -m pip install -r doc/requirements.txt
 
       - name: Install QuTiP from GitHub
         run: |
-          python -mpip install git+https://github.com/qutip/qutip.git@master
+          python -m pip install git+https://github.com/qutip/qutip.git@master
           python -c 'import qutip; qutip.about()'
 
       - name: Install qutip-jax from GitHub
         run: |
-          python -mpip install .[full]
+          python -m pip install jax jax[cpu]
+          python -m pip install .[full]
           python -c 'import qutip_jax; print(qutip_jax.__version__)'
 
       - name: Build documentation

.github/workflows/tests.yml

@@ -36,15 +36,16 @@ jobs:
 
       - name: Install QuTiP from GitHub
         run: |
-          python -mpip install git+https://github.com/qutip/qutip.git@master
+          python -m pip install git+https://github.com/qutip/qutip.git@master
           python -c 'import qutip; qutip.about()'
 
       - name: Install qutip-jax and dependencies
         # Install in editable mode so Coveralls detects the tree structure
         # relative to the git repository root as well.
         run: |
-            python -mpip install -e .[full]
-            python -mpip install pytest-cov coveralls
+            python -m pip install jax jax[cpu]
+            python -m pip install -e .[full]
+            python -m pip install pytest-cov coveralls
 
       - name: Package information
         run: |

.github/workflows/weekly.yml

@@ -51,7 +51,8 @@ jobs:
         # Install in editable mode so Coveralls detects the tree structure
         # relative to the git repository root as well.
         run: |
-            python -mpip install -e .[full]
+            python -m pip install jax jax[cpu]
+            python -m pip install -e .[full]
 
       - name: Package information
         run: |

doc/requirements.txt

@@ -1,8 +1,8 @@
-numpy==1.22.4
-scipy==1.7.3
-qutip==5.0.0a2
-cython==3.0.2
-Sphinx==6.1.3
+numpy>=1.22.4
+scipy>=1.7.3
+qutip>=5.0.0
+cython>=3.0.2
+Sphinx>=6.1.3
 sphinx-rtd-theme==1.2.0
 sphinx-gallery==0.12.2
 sphinxcontrib-applehelp==1.0.3
@@ -17,4 +17,5 @@ numpydoc==1.4.0
 matplotlib==3.7.1
 docutils==0.18.1
 jax
+jax[cpu]
 jaxlib

doc/source/basics.rst

@@ -64,7 +64,7 @@ There are many ways to create a QuTiP ``Qobj`` backed by JAX's array class.
     import qutip
     import qutip_jax
 
-    with qutip.CoreOptions("default_dtype"="jax"):
+    with qutip.CoreOptions(default_dtype="jax"):
         jax_eye_qobj = qutip.qeye(3)
 
     assert isinstance(jax_eye_qobj.data, qutip_jax.JaxArray)

setup.cfg

@@ -30,7 +30,6 @@ include_package_data = True
 install_requires =
     qutip>=5.0.0
     jax
-    jax[cpu]
     diffrax
     equinox
 setup_requires =