Merge branch 'master' of https://github.com/OpenQuantumDesign/oqd-trical into test

Author: yhteoh

.github/ISSUE_TEMPLATE.md

@@ -26,4 +26,4 @@
   - Subsystem:
 
 
-* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)
+* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)

.github/workflows/check_copyright.yml

@@ -10,6 +10,6 @@ jobs:
       - name: Check license & copyright headers
         uses: viperproject/check-license-header@v2
         with:
-          path: 
+          path:
           config: .github/workflows/check_copyright_config.json
-          # strict: true
+          # strict: true

.github/workflows/check_mkdocs_build.yml

@@ -21,4 +21,4 @@ jobs:
         uses: astral-sh/setup-uv@v4
       # - run: cp -r examples/ docs/examples/
       - run: uv pip install .[docs] --system
-      - run: mkdocs build
+      - run: mkdocs build

.github/workflows/copyright.txt

@@ -10,4 +10,4 @@
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
-# limitations under the License.
+# limitations under the License.

.gitignore

@@ -167,4 +167,4 @@ cython_debug/
 _scripts
 _docs
 
-.pre-commit-config.yaml
+.pre-commit-config.yaml

docs/explanation/backends.md

@@ -0,0 +1,34 @@
+# Backends
+
+Backends are used to execute the AtomicCircuit.
+
+## Supported Backends
+
+- [QuTiP](https://qutip.readthedocs.io/en/latest/) <div style="float:right;"> [![](https://img.shields.io/badge/Implementation-7C4DFF)][oqd_trical.backend.qutip.QutipBackend] </div>
+- [Dynamiqs](https://qutip.readthedocs.io/en/latest/) <div style="float:right;"> [![](https://img.shields.io/badge/Implementation-7C4DFF)][oqd_trical.backend.dynamiqs.DynamiqsBackend] </div>
+
+## Compile
+
+Compiles the AtomicCircuit into a compatible form for the backend to run on.
+
+<!-- prettier-ignore -->
+/// admonition | Examples
+    type: example
+
+- QuTiP requires the AtomicCircuit be compiled to a [`QutipExperiment`][oqd_trical.backend.qutip.interface.QutipExperiment].
+- Dynamiqs requires the AtomicCircuit be compiled to a [`DynamiqsExperiment`][oqd_trical.backend.dynamiqs.interface.DynamiqsExperiment].
+
+///
+
+## Run
+
+Executes the compatible form of the AtomicCircuit with the backend using a tree walking interpreter.
+
+<!-- prettier-ignore -->
+/// admonition | Examples
+    type: example
+
+- QuTiP uses [`QutipVM`][oqd_trical.backend.qutip.vm.QutipVM] as its tree walking interpreter.
+- Dynamiqs uses [`DynamiqsVM`][oqd_trical.backend.dynamiqs.vm.DynamiqsVM] as its tree walking interpreter.
+
+///

docs/explanation/hamiltonian_construction/additional.md

@@ -3,7 +3,7 @@
 These formulas are often computed using helper functions as part of the Hamiltonian construction process. When this is the case, the name and location of the helper function is specified.
 
 <!-- prettier-ignore -->
-/// admonition | 
+/// admonition |
     type: card
 
 $$
@@ -16,7 +16,7 @@ $$
 ///
 
 <!-- prettier-ignore -->
-/// admonition | 
+/// admonition |
     type: card
 
 $$
@@ -29,7 +29,7 @@ Used in [intensity_from_laser][oqd_trical.light_matter.compiler.utils.intensity_
 ///
 
 <!-- prettier-ignore -->
-/// admonition | 
+/// admonition |
     type: card
 
 $$
@@ -43,7 +43,7 @@ Used in [rabi_from_intensity][oqd_trical.light_matter.compiler.utils.rabi_from_i
 ///
 
 <!-- prettier-ignore -->
-/// admonition | 
+/// admonition |
     type: card
 
 $$

docs/reference/dynamiqs.md

@@ -0,0 +1 @@
+::: oqd_trical.backend.dynamiqs

docs/stylesheets/admonition_template.css

@@ -14,4 +14,4 @@
     background-color: #FFFFFF;
     -webkit-mask-image: var(--md-admonition-icon--template);
             mask-image: var(--md-admonition-icon--template);
-  }
+  }

docs/stylesheets/admonitions.css

@@ -36,7 +36,7 @@
             mask-image: var(--md-admonition-icon--important);
   }
 
-  
+
 
   :root {
     --md-admonition-icon--note: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="size-6"><path stroke-linecap="round" stroke-linejoin="round" d="m16.862 4.487 1.687-1.688a1.875 1.875 0 1 1 2.652 2.652L10.582 16.07a4.5 4.5 0 0 1-1.897 1.13L6 18l.8-2.685a4.5 4.5 0 0 1 1.13-1.897l8.932-8.931Zm0 0L19.5 7.125M18 14v4.75A2.25 2.25 0 0 1 15.75 21H5.25A2.25 2.25 0 0 1 3 18.75V8.25A2.25 2.25 0 0 1 5.25 6H10" /></svg>')
@@ -55,7 +55,7 @@
     -webkit-mask-image: var(--md-admonition-icon--note);
             mask-image: var(--md-admonition-icon--note);
   }
-  
+
   :root {
     --md-admonition-icon--warning: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="size-6"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v3.75m-9.303 3.376c-.866 1.5.217 3.374 1.948 3.374h14.71c1.73 0 2.813-1.874 1.948-3.374L13.949 3.378c-.866-1.5-3.032-1.5-3.898 0L2.697 16.126ZM12 15.75h.007v.008H12v-.008Z" /></svg>')
   }
@@ -79,7 +79,7 @@
   }
 
 
-  
+
   .md-typeset .admonition.card,
   .md-typeset details.card {
     border-color: #C2185B;
@@ -93,4 +93,4 @@
     background-color: #C2185B;
     -webkit-mask-image: var(--md-admonition-icon--card);
             mask-image: var(--md-admonition-icon--card);
-  }
+  }