Skip to content

Commit

Permalink
Merge branch 'qutip:master' into heom_mauro_inputoutpuit
Browse files Browse the repository at this point in the history
  • Loading branch information
nwlambert authored Nov 1, 2024
2 parents 6ca7c1b + 464112a commit 9175faa
Show file tree
Hide file tree
Showing 33 changed files with 660 additions and 522 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@ jobs:
# to see if something hung.
timeout-minutes: 60
run: |
export MKL_VERBOSE=2
if [[ -n "${{ matrix.openmp }}" ]]; then
# Force OpenMP runs to use more threads, even if there aren't
# actually that many CPUs. We have to check any dispatch code is
Expand Down Expand Up @@ -265,6 +266,8 @@ jobs:

- name: Install Towncrier
run: |
python -m venv towncrier_check
source towncrier_check/bin/activate
python -m pip install towncrier
- name: Verify Towncrier entry added
Expand All @@ -276,6 +279,7 @@ jobs:
# compare the current branch with the base branch.
# Source: https://github.com/actions/checkout/#fetch-all-branches.
git fetch --no-tags origin +refs/heads/${BASE_BRANCH}:refs/remotes/origin/${BASE_BRANCH}
source towncrier_check/bin/activate
towncrier check --compare-with origin/${BASE_BRANCH}
towncrier build --version "$(cat VERSION)" --draft
Expand Down
10 changes: 8 additions & 2 deletions doc/apidoc/apidoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
39 changes: 39 additions & 0 deletions doc/apidoc/experimental.rst
Original file line number Diff line number Diff line change
@@ -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:
Loading

0 comments on commit 9175faa

Please sign in to comment.