Skip to content

Commit

Permalink
Merge pull request qutip#1569 from paniash/fix-typos
Browse files Browse the repository at this point in the history
Fixed numerous typos in docs.
  • Loading branch information
hodgestar committed Jun 21, 2021
2 parents 5292350 + 8752caf commit 3432bfe
Show file tree
Hide file tree
Showing 8 changed files with 128 additions and 35 deletions.
4 changes: 2 additions & 2 deletions doc/guide/dynamics/dynamics-floquet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ The :math:`t=0` Floquet modes corresponding to the Hamiltonian :eq:`eq_driven_qu
[[0.39993746+0.554682j]
[0.72964231+0.j ]]]

For some problems interesting observations can be draw from the quasienergy levels alone. Consider for example the quasienergies for the driven two-level system introduced above as a function of the driving amplitude, calculated and plotted in the following example. For certain driving amplitudes the quasienergy levels cross. Since the the quasienergies can be associated with the time-scale of the long-term dynamics due that the driving, degenerate quasienergies indicates a "freezing" of the dynamics (sometimes known as coherent destruction of tunneling).
For some problems interesting observations can be draw from the quasienergy levels alone. Consider for example the quasienergies for the driven two-level system introduced above as a function of the driving amplitude, calculated and plotted in the following example. For certain driving amplitudes the quasienergy levels cross. Since the quasienergies can be associated with the time-scale of the long-term dynamics due that the driving, degenerate quasienergies indicates a "freezing" of the dynamics (sometimes known as coherent destruction of tunneling).

.. plot::
:context:
Expand Down Expand Up @@ -223,7 +223,7 @@ A driven system that is interacting with its environment is not necessarily well
The Floquet-Markov master equation in QuTiP
-------------------------------------------

The QuTiP function :func:`qutip.floquet.fmmesolve` implements the Floquet-Markov master equation. It calculates the dynamics of a system given its initial state, a time-dependent hamiltonian, a list of operators through which the system couples to its environment and a list of corresponding spectral-density functions that describes the environment. In contrast to the :func:`qutip.mesolve` and :func:`qutip.mcsolve`, and the :func:`qutip.floquet.fmmesolve` does characterize the environment with dissipation rates, but extract the strength of the coupling to the environment from the noise spectral-density functions and the instantaneous Hamiltonian parameters (similar to the Bloch-Redfield master equation solver :func:`qutip.bloch_redfield.brmesolve`).
The QuTiP function :func:`qutip.floquet.fmmesolve` implements the Floquet-Markov master equation. It calculates the dynamics of a system given its initial state, a time-dependent Hamiltonian, a list of operators through which the system couples to its environment and a list of corresponding spectral-density functions that describes the environment. In contrast to the :func:`qutip.mesolve` and :func:`qutip.mcsolve`, and the :func:`qutip.floquet.fmmesolve` does characterize the environment with dissipation rates, but extract the strength of the coupling to the environment from the noise spectral-density functions and the instantaneous Hamiltonian parameters (similar to the Bloch-Redfield master equation solver :func:`qutip.bloch_redfield.brmesolve`).

.. note::

Expand Down
12 changes: 6 additions & 6 deletions doc/guide/guide-bloch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Plotting on the Bloch Sphere
Introduction
============

When studying the dynamics of a two-level system, it is often convent to visualize the state of the system by plotting the state-vector or density matrix on the Bloch sphere. In QuTiP, we have created two different classes to allow for easy creation and manipulation of data sets, both vectors and data points, on the Bloch sphere. The :class:`qutip.Bloch` class, uses Matplotlib to render the Bloch sphere, where as :class:`qutip.Bloch3d` uses the Mayavi rendering engine to generate a more faithful 3D reconstruction of the Bloch sphere.
When studying the dynamics of a two-level system, it is often convenient to visualize the state of the system by plotting the state-vector or density matrix on the Bloch sphere. In QuTiP, we have created two different classes to allow for easy creation and manipulation of data sets, both vectors and data points, on the Bloch sphere. The :class:`qutip.Bloch` class, uses Matplotlib to render the Bloch sphere, where as :class:`qutip.Bloch3d` uses the Mayavi rendering engine to generate a more faithful 3D reconstruction of the Bloch sphere.

.. _bloch-class:

Expand Down Expand Up @@ -146,7 +146,7 @@ Adding multiple points to the Bloch sphere works slightly differently than addin
b.add_points(pnts)
b.render()

Notice that, in contrast to states or vectors, each point remains the same color as the initial point. This is because adding multiple data points using the add_points function is interpreted, by default, to correspond to a single data point (single qubit state) plotted at different times. This is very useful when visualizing the dynamics of a qubit. An example of this is given in the example . If we want to plot additional qubit states we can call additional `add_points` functions:
Notice that, in contrast to states or vectors, each point remains the same color as the initial point. This is because adding multiple data points using the ``add_points`` function is interpreted, by default, to correspond to a single data point (single qubit state) plotted at different times. This is very useful when visualizing the dynamics of a qubit. An example of this is given in the example . If we want to plot additional qubit states we can call additional ``add_points`` functions:

.. plot::
:context: close-figs
Expand Down Expand Up @@ -202,7 +202,7 @@ While in general the ``Bloch`` and ``Bloch3d`` classes are interchangeable, ther

- Only the ``Bloch`` class can be embedded in a Matplotlib figure window. Thus if you want to combine a Bloch sphere with another figure generated in QuTiP, you can not use ``Bloch3d``. Of course you can always post-process your figures using other software to get the desired result.

- Due to limitations in the rendering engine, the ``Bloch3d`` class does not support LaTex for text. Again, you can get around this by post-processing.
- Due to limitations in the rendering engine, the ``Bloch3d`` class does not support LaTeX for text. Again, you can get around this by post-processing.

- The user customizable attributes for the ``Bloch`` and ``Bloch3d`` classes are not identical. Therefore, if you change the properties of one of the classes, these changes will cause an exception if the class is switched.

Expand Down Expand Up @@ -405,7 +405,7 @@ An example of generating images for generating an animation outside of Python is
b.add_points([sx[:i+1], sy[:i+1], sz[:i+1]])
b.save(dirc='temp') # saving images to temp directory in current working directory

Generating an animation using ffmpeg (for example) is fairly simple::
Generating an animation using FFmpeg (for example) is fairly simple::

ffmpeg -i temp/bloch_%01d.png bloch.mp4

Expand All @@ -415,8 +415,8 @@ Directly Generating an Animation
++++++++++++++++++++++++++++++++

.. important::
Generating animations directly from Matplotlib requires installing either mencoder or ffmpeg.
While either choice works on linux, it is best to choose ffmpeg when running on the Mac.
Generating animations directly from Matplotlib requires installing either MEncoder or FFmpeg.
While either choice works on linux, it is best to choose FFmpeg when running on the Mac.
If using macports just do: ``sudo port install ffmpeg``.

The code to directly generate an mp4 movie of the Qubit decay is as follows ::
Expand Down
Loading

0 comments on commit 3432bfe

Please sign in to comment.