copy documentation from qtrl

.github/workflows/build_documentation.yml

@@ -9,12 +9,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v2
         name: Install Python
         with:
-          python-version: '3.8'
+          python-version: '3.9'
 
       - name: Install Pandoc
         run: |
@@ -44,8 +44,8 @@ jobs:
           #   -T : display a full traceback if a Python exception occurs
 
       - name: Upload built files
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v2
         with:
-          name: qutip_qoc_html_docs
+          name: qutip-qoc_html_docs
           path: doc/_build/html/*
           if-no-files-found: error

README.md

@@ -11,7 +11,8 @@ The global optimization layer provides ``scipy.optimize.dual_annealing`` and ``s
 gradient driven ``scipy.optimize.minimize`` methods.
 
 The package also aims for a more general way of defining control problems with QuTiP and makes switching between the four control algorithms very easy.
-The qutip-qoc package aims at providing advanced tools for the optimal control of quantum devices.
+
+As with qutip-qtrl, the qutip-qoc package aims at providing advanced tools for the optimal control of quantum devices.
 Compared to other libraries for quantum optimal control, qutip-qoc puts additional emphasis on the physics layer and the interaction with the QuTiP package.
 The package offers support for both the CRAB and GRAPE methods.
 

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/apidoc.rst

@@ -0,0 +1,54 @@
+qutip\_qtrl package
+===================
+
+
+.. toctree::
+   :maxdepth: 1
+
+
+High-level interfaces
+---------------------
+High-level interfaces to the optimal control features.
+
+.. autosummary::
+   :toctree: apidoc/
+   :template: autosummary/module.rst
+
+   qutip_qtrl.pulseoptim
+
+.. todo::
+
+   Add qutip_qtrl.grape to above.
+
+Utilities
+---------
+Optimal control utility functions.
+
+.. autosummary::
+   :toctree: apidoc/
+   :template: autosummary/module.rst
+
+   qutip_qtrl.dump
+   qutip_qtrl.errors
+   qutip_qtrl.loadparams
+   qutip_qtrl.io
+   qutip_qtrl.stats
+
+Low-level interfaces
+--------------------
+Internal interfaces to the optimal control features.
+
+.. autosummary::
+   :toctree: apidoc/
+   :template: autosummary/module.rst
+
+   qutip_qtrl.dynamics
+   qutip_qtrl.fidcomp
+   qutip_qtrl.optimizer
+   qutip_qtrl.optimconfig
+   qutip_qtrl.optimresult
+   qutip_qtrl.propcomp
+   qutip_qtrl.pulsegen
+   qutip_qtrl.symplectic
+   qutip_qtrl.termcond
+   qutip_qtrl.tslotcomp

doc/apidoc/qutip_qtrl.dump.rst

@@ -0,0 +1,16 @@
+qutip\_qtrl.dump
+================
+
+.. automodule:: qutip_qtrl.dump
+   :members:
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Dump
+      DumpItem
+      DumpSummaryItem
+      DynamicsDump
+      EvoCompDumpItem
+      OptimDump

doc/apidoc/qutip_qtrl.dynamics.rst

@@ -0,0 +1,14 @@
+qutip\_qtrl.dynamics
+====================
+
+.. automodule:: qutip_qtrl.dynamics
+   :members:
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Dynamics
+      DynamicsGenMat
+      DynamicsSymplectic
+      DynamicsUnitary

doc/apidoc/qutip_qtrl.errors.rst

@@ -0,0 +1,18 @@
+qutip\_qtrl.errors
+==================
+
+.. automodule:: qutip_qtrl.errors
+   :members:
+
+   .. rubric:: Exceptions
+
+   .. autosummary::
+
+      Error
+      FunctionalError
+      GoalAchievedTerminate
+      GradMinReachedTerminate
+      MaxFidFuncCallTerminate
+      MaxWallTimeTerminate
+      OptimizationTerminate
+      UsageError

doc/apidoc/qutip_qtrl.fidcomp.rst

@@ -0,0 +1,14 @@
+qutip\_qtrl.fidcomp
+===================
+
+.. automodule:: qutip_qtrl.fidcomp
+   :members:
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      FidCompTraceDiff
+      FidCompTraceDiffApprox
+      FidCompUnitary
+      FidelityComputer

doc/apidoc/qutip_qtrl.io.rst

@@ -0,0 +1,11 @@
+qutip\_qtrl.io
+==============
+
+.. automodule:: qutip_qtrl.io
+   :members:
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      create_dir

doc/apidoc/qutip_qtrl.loadparams.rst

@@ -0,0 +1,12 @@
+qutip\_qtrl.loadparams
+======================
+
+.. automodule:: qutip_qtrl.loadparams
+   :members:
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      load_parameters
+      set_param

doc/apidoc/qutip_qtrl.optimconfig.rst

@@ -0,0 +1,11 @@
+qutip\_qtrl.optimconfig
+=======================
+
+.. automodule:: qutip_qtrl.optimconfig
+   :members:
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      OptimConfig

doc/apidoc/qutip_qtrl.optimizer.rst

@@ -0,0 +1,16 @@
+qutip\_qtrl.optimizer
+=====================
+
+.. automodule:: qutip_qtrl.optimizer
+   :members:
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      OptimIterSummary
+      Optimizer
+      OptimizerBFGS
+      OptimizerCrab
+      OptimizerCrabFmin
+      OptimizerLBFGSB

doc/apidoc/qutip_qtrl.optimresult.rst

@@ -0,0 +1,11 @@
+qutip\_qtrl.optimresult
+=======================
+
+.. automodule:: qutip_qtrl.optimresult
+   :members:
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      OptimResult

doc/apidoc/qutip_qtrl.propcomp.rst

@@ -0,0 +1,15 @@
+qutip\_qtrl.propcomp
+====================
+
+.. automodule:: qutip_qtrl.propcomp
+   :members:
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      PropCompApproxGrad
+      PropCompAugMat
+      PropCompDiag
+      PropCompFrechet
+      PropagatorComputer

doc/apidoc/qutip_qtrl.pulsegen.rst

@@ -0,0 +1,33 @@
+qutip\_qtrl.pulsegen
+====================
+
+.. automodule:: qutip_qtrl.pulsegen
+   :members:
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      create_pulse_gen
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      PulseGen
+      PulseGenCrab
+      PulseGenCrabFourier
+      PulseGenGaussian
+      PulseGenGaussianEdge
+      PulseGenLinear
+      PulseGenPeriodic
+      PulseGenRandom
+      PulseGenRndFourier
+      PulseGenRndWalk1
+      PulseGenRndWalk2
+      PulseGenRndWaves
+      PulseGenSaw
+      PulseGenSine
+      PulseGenSquare
+      PulseGenTriangle
+      PulseGenZero

doc/apidoc/qutip_qtrl.pulseoptim.rst

@@ -0,0 +1,15 @@
+qutip\_qtrl.pulseoptim
+======================
+
+.. automodule:: qutip_qtrl.pulseoptim
+   :members:
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      create_pulse_optimizer
+      opt_pulse_crab
+      opt_pulse_crab_unitary
+      optimize_pulse
+      optimize_pulse_unitary

doc/apidoc/qutip_qtrl.stats.rst

@@ -0,0 +1,12 @@
+qutip\_qtrl.stats
+=================
+
+.. automodule:: qutip_qtrl.stats
+   :members:
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Stats
+      StatsDynTsUpdate

doc/apidoc/qutip_qtrl.symplectic.rst

@@ -0,0 +1,11 @@
+qutip\_qtrl.symplectic
+======================
+
+.. automodule:: qutip_qtrl.symplectic
+   :members:
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      calc_omega

doc/apidoc/qutip_qtrl.termcond.rst

@@ -0,0 +1,11 @@
+qutip\_qtrl.termcond
+====================
+
+.. automodule:: qutip_qtrl.termcond
+   :members:
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      TerminationConditions

doc/apidoc/qutip_qtrl.tslotcomp.rst

@@ -0,0 +1,14 @@
+qutip\_qtrl.tslotcomp
+=====================
+
+.. automodule:: qutip_qtrl.tslotcomp
+   :members:
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      EvoCompSummary
+      TSlotCompDynUpdate
+      TSlotCompUpdateAll
+      TimeslotComputer

doc/bibliography.rst

@@ -0,0 +1,7 @@
+************
+Bibliography
+************
+
+.. bibliography::
+    :cited:
+    :style: unsrt