Merge remote-tracking branch 'upstream/master' into bath_pr_refactor2

gsuarezr · Oct 11, 2024 · fbb7b26 · fbb7b26
2 parents 274c9c2 + 061a4b4
commit fbb7b26
Show file tree

Hide file tree

Showing 24 changed files with 672 additions and 683 deletions.
diff --git a/doc/apidoc/apidoc.rst b/doc/apidoc/apidoc.rst
@@ -10,5 +10,11 @@ complete list of QuTiP's public classes and functions.
 .. toctree::
    :maxdepth: 3
 
-   classes.rst 
-   functions.rst
+   quantumobject.rst
+   time_dep.rst
+   solver.rst
+   heom.rst
+   piqs.rst
+   visualization.rst
+   utilities.rst
+   experimental.rst
diff --git a/doc/apidoc/classes.rst b/doc/apidoc/classes.rst
diff --git a/doc/apidoc/experimental.rst b/doc/apidoc/experimental.rst
@@ -0,0 +1,39 @@
+
+************
+Experimental
+************
+
+.. note::
+
+  Functions here are untested and under-documented.
+
+Continuous Variables
+--------------------
+
+.. automodule:: qutip.continuous_variables
+    :members: correlation_matrix, covariance_matrix, correlation_matrix_field, correlation_matrix_quadrature, wigner_covariance_matrix, logarithmic_negativity
+
+
+Distribution functions
+----------------------
+
+.. autoclass:: qutip.distributions.Distribution
+    :members:
+
+..
+  Docstrings are empty...
+
+  .. autoclass:: qutip.distributions.WignerDistribution
+      :members:
+
+  .. autoclass:: qutip.distributions.QDistribution
+      :members:
+
+  .. autoclass:: qutip.distributions.TwoModeQuadratureCorrelation
+      :members:
+
+  .. autoclass:: qutip.distributions.HarmonicOscillatorWaveFunction
+      :members:
+
+  .. autoclass:: qutip.distributions.HarmonicOscillatorProbabilityFunction
+      :members: