mkdocs.yml

site_name: dynamiqs
site_url: "https://www.dynamiqs.org"
use_directory_urls: false
repo_url: https://github.com/dynamiqs/dynamiqs
repo_name: dynamiqs
theme:
  name: material
  custom_dir: docs/overrides
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - search.suggest
    - content.code.copy
    - content.tooltips
  icon:
    repo: fontawesome/brands/github
    admonition:
      example: material/human-male-board
  logo: media/logo.png
  favicon: media/favicon.svg
  palette:
    # palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
copyright: "&copy Copyright 2023, dynamiqs developers."
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/dynamiqs/dynamiqs
    - icon: fontawesome/brands/slack
      link: https://join.slack.com/t/dynamiqs-org/shared_invite/zt-1z4mw08mo-qDLoNx19JBRtKzXlmlFYLA
extra_css:
  - stylesheets/extra.css
  - stylesheets/theme.css
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
plugins:
  - search
  - glightbox:
      effect: fade
      slide_effect: slide
      width: 70%
      zoomable: false
      draggable: false
  - mkdocs-simple-hooks:
      hooks:
        on_env: "docs.hooks:on_env"
  - gen-files:
      scripts:
        - docs/generate_python_api.py
  - mkdocstrings:
      default_handler: python
      custom_templates: docs/templates
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            show_root_toc_entry: false
            show_root_full_path: false
            heading_level: 1
            members_order: source
            docstring_section_style: list
            show_signature_annotations: true
            separate_signature: true
            line_length: 88
            show_bases: false
            merge_init_into_class: true
markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.caret
  - pymdownx.snippets:
      auto_append:
        - includes/glossary.md
  - abbr
  - attr_list
  - footnotes
  - md_in_html
extra_javascript:
  - javascripts/katex.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
watch:
  - dynamiqs
  - includes
validation:
  nav:
    omitted_files: warn
    not_found: warn
    absolute_links: warn
  links:
    not_found: warn
    absolute_links: ignore
    unrecognized_links: warn
nav:
  - Home: index.md
  - Getting started:
      - getting_started/index.md
      - What is dynamiqs?: getting_started/whatis.md
      - Installation: getting_started/installation.md
      - Basic examples: getting_started/examples.md
      - The sharp bits 🔪: getting_started/sharp-bits.md
      - Contributing: getting_started/contributing.md
      - Let's talk!: getting_started/lets-talk.md
      - Citing dynamiqs: getting_started/citing.md
  - Tutorials:
      - tutorials/index.md
      - Basics:
          - Workflow in dynamiqs: tutorials/workflow.md
          - tutorials/time-dependent-operators.md
          - tutorials/closed-system.md
          - tutorials/open-system.md
          - tutorials/batching-simulations.md
          - tutorials/computing-gradients.md
  - Python API:
      - python_api/index.md
      - Quantum solvers:
          - sesolve: python_api/solvers/sesolve.md
          - mesolve: python_api/solvers/mesolve.md
          - smesolve: python_api/solvers/smesolve.md
      - Core:
          - Time-dependent arrays:
              - TimeArray: python_api/time_array/TimeArray.md
              - constant: python_api/time_array/constant.md
              - pwc: python_api/time_array/pwc.md
              - modulated: python_api/time_array/modulated.md
              - timecallable: python_api/time_array/timecallable.md
          - Solvers (dq.solver):
              - Tsit5: python_api/solver/Tsit5.md
              - Dopri5: python_api/solver/Dopri5.md
              - Dopri8: python_api/solver/Dopri8.md
              - Euler: python_api/solver/Euler.md
              - Rouchon1: python_api/solver/Rouchon1.md
              - Rouchon2: python_api/solver/Rouchon2.md
              - Propagator: python_api/solver/Propagator.md
          - Gradients (dq.gradient):
              - Autograd: python_api/gradient/Autograd.md
              - CheckpointAutograd: python_api/gradient/CheckpointAutograd.md
          - Options: python_api/options/Options.md
          - Results:
              - SEResult: python_api/result/SEResult.md
              - MEResult: python_api/result/MEResult.md
      - Utilities:
          - Operators:
              - eye: python_api/utils/operators/eye.md
              - zero: python_api/utils/operators/zero.md
              - destroy: python_api/utils/operators/destroy.md
              - create: python_api/utils/operators/create.md
              - number: python_api/utils/operators/number.md
              - parity: python_api/utils/operators/parity.md
              - displace: python_api/utils/operators/displace.md
              - squeeze: python_api/utils/operators/squeeze.md
              - quadrature: python_api/utils/operators/quadrature.md
              - position: python_api/utils/operators/position.md
              - momentum: python_api/utils/operators/momentum.md
              - sigmax: python_api/utils/operators/sigmax.md
              - sigmay: python_api/utils/operators/sigmay.md
              - sigmaz: python_api/utils/operators/sigmaz.md
              - sigmap: python_api/utils/operators/sigmap.md
              - sigmam: python_api/utils/operators/sigmam.md
              - hadamard: python_api/utils/operators/hadamard.md
          - States:
              - fock: python_api/utils/states/fock.md
              - fock_dm: python_api/utils/states/fock_dm.md
              - basis: python_api/utils/states/basis.md
              - basis_dm: python_api/utils/states/basis_dm.md
              - coherent: python_api/utils/states/coherent.md
              - coherent_dm: python_api/utils/states/coherent_dm.md
          - Quantum utilities:
              - dag: python_api/utils/utils/dag.md
              - powm: python_api/utils/utils/powm.md
              - cosm: python_api/utils/utils/cosm.md
              - sinm: python_api/utils/utils/sinm.md
              - tracemm: python_api/utils/utils/tracemm.md
              - trace: python_api/utils/utils/trace.md
              - ptrace: python_api/utils/utils/ptrace.md
              - tensor: python_api/utils/utils/tensor.md
              - expect: python_api/utils/utils/expect.md
              - norm: python_api/utils/utils/norm.md
              - unit: python_api/utils/utils/unit.md
              - dissipator: python_api/utils/utils/dissipator.md
              - lindbladian: python_api/utils/utils/lindbladian.md
              - isket: python_api/utils/utils/isket.md
              - isbra: python_api/utils/utils/isbra.md
              - isdm: python_api/utils/utils/isdm.md
              - isop: python_api/utils/utils/isop.md
              - isherm: python_api/utils/utils/isherm.md
              - toket: python_api/utils/utils/toket.md
              - tobra: python_api/utils/utils/tobra.md
              - todm: python_api/utils/utils/todm.md
              - proj: python_api/utils/utils/proj.md
              - braket: python_api/utils/utils/braket.md
              - overlap: python_api/utils/utils/overlap.md
              - fidelity: python_api/utils/utils/fidelity.md
              - entropy_vn: python_api/utils/utils/entropy_vn.md
              - eigenstates: python_api/utils/utils/eigenstates.md
              - wigner: python_api/utils/utils/wigner.md
          - JAX-related utilities:
              - to_qutip: python_api/utils/jax_utils/to_qutip.md
              - set_device: python_api/utils/jax_utils/set_device.md
              - set_precision: python_api/utils/jax_utils/set_precision.md
          - Vectorization:
              - operator_to_vector: python_api/utils/vectorization/operator_to_vector.md
              - vector_to_operator: python_api/utils/vectorization/vector_to_operator.md
              - spre: python_api/utils/vectorization/spre.md
              - spost: python_api/utils/vectorization/spost.md
              - sprepost: python_api/utils/vectorization/sprepost.md
              - sdissipator: python_api/utils/vectorization/sdissipator.md
              - slindbladian: python_api/utils/vectorization/slindbladian.md
          - Quantum optimal control:
              - snap_gate: python_api/utils/optimal_control/snap_gate.md
              - cd_gate: python_api/utils/optimal_control/cd_gate.md
          - Random arrays:
              - rand_real: python_api/utils/random/rand_real.md
              - rand_complex: python_api/utils/random/rand_complex.md
              - rand_herm: python_api/utils/random/rand_herm.md
              - rand_psd: python_api/utils/random/rand_psd.md
              - rand_dm: python_api/utils/random/rand_dm.md
              - rand_ket: python_api/utils/random/rand_ket.md
          - Plotting:
              - plot_wigner: python_api/plots/plot_wigner.md
              - plot_wigner_mosaic: python_api/plots/plot_wigner_mosaic.md
              - plot_wigner_gif: python_api/plots/plot_wigner_gif.md
              - plot_pwc_pulse: python_api/plots/plot_pwc_pulse.md
              - plot_fock: python_api/plots/plot_fock.md
              - plot_fock_evolution: python_api/plots/plot_fock_evolution.md
              - plot_hinton: python_api/plots/plot_hinton.md
              - gridplot: python_api/plots/gridplot.md