mkdocs.yml

site_url: "https://qmcsoftware.github.io/QMCSoftware/"
site_name: "QMCPy"
nav:
  - Quasi Monte Carlo Software: README.md
  - Community Resources:
    - QMC Software Packages: qmc-software.md
    - PyPI Download Statistics: stats/pypi_downloads.md
  - Components: components.md
  - Contributing: CONTRIBUTING.md
  - Community: community.md
  - Leadership: QMCPy_Shared_Leadership.md
  - Package Reference:
    - Discrete Distributions: api/discrete_distributions.md
    - True Measures: api/true_measures.md
    - Integrands: api/integrands.md
    - Stopping Criteria: api/stopping_criteria.md
    - Kernels: api/kernels.md
    - Fast Transforms: api/fast_transforms.md
    - Util: api/util.md
  - Demos:
    - Getting Started:
      - Introduction: demos/qmcpy_intro.ipynb
      - Quickstart: demos/quickstart.ipynb
      - Pricing Options: demos/pricing_options.ipynb
      - Lebesgue Integration: demos/lebesgue_integration.ipynb
    - Resume and Iteration Logging:
      - Resume Feature Quickstart: demos/demo_resume_data/resume_examples.ipynb
      - Accuracy and Resume: demos/demo_resume_data/accuracy_and_resume.ipynb
      - Iteration Log and Tolerance: demos/demo_resume_data/Iteration_Log_Tolerance_Demo.ipynb
    - Publication Notebooks:
      - 2026 Random LD Seq., QMC, and Fast Kernel Methods: demos/talk_paper_demos/Sorokin_random_LD_seq_QMC_fast_kernel_methods_2026/Sorokin_random_LD_seq_QMC_fast_kernel_methods_2026.ipynb
      - 2026 JOSS Paper: demos/talk_paper_demos/JOSS2026/joss2026.ipynb
      - 2025 Sorokin Thesis: demos/talk_paper_demos/SorokinThesis2025/sorokin_thesis_2025.ipynb
      - 2025 ParslFest:
        - Parallel Implementation: demos/talk_paper_demos/Parslfest_2025/02_parallel.ipynb
        - Sequential Implementation: demos/talk_paper_demos/Parslfest_2025/01_sequential.ipynb
        - Speedup Visualization: demos/talk_paper_demos/Parslfest_2025/03_visualize_speedup.ipynb
        - Sequential Output: demos/talk_paper_demos/Parslfest_2025/output/01_sequential_output.ipynb
      - 2023 Argonne Talk: demos/talk_paper_demos/Argonne_Talk_2023_May/Argonne_2023_Talk_Figures.ipynb
      - 2022 MCQMC Paper 1: demos/talk_paper_demos/MCQMC2022_Article_Figures/MCQMC2022_Article_Figures.ipynb
      - 2022 MCQMC Paper 2:
        - Vectorized QMC Algorithms Tracking Fourier Coefficient Decay: demos/vectorized_qmc.ipynb
        - Vectorized QMC Bayesian Cubature: demos/vectorized_qmc_bayes.ipynb
      - 2023 Probability of Failure Paper: demos/talk_paper_demos/ProbFailureSorokinRao/prob_failure_gp_ci.ipynb
      - 2023 Purdue Talk: demos/talk_paper_demos/Purdue_Talk_2023_March/Purdue_Talk_Figures.ipynb
      - 2023 PyData Chicago Talk: demos/talk_paper_demos/pydata_chi_2023.ipynb
      - 2020 MCQMC Software Tutorial: demos/talk_paper_demos/MCQMC_Tutorial_2020/MCQMC_2020_QMC_Software_Tutorial.ipynb
    - Technical Examples:
      - 2023 Random Lattice Generating Vectors: demos/lattice_random_generator.ipynb
      - 2022 Bayesian Cubature Stopping Criterion: demos/gaussian_diagnostics/gaussian_diagnostics_demo.ipynb
      - 2020 Why Add Q to MC?: demos/talk_paper_demos/why_add_q_to_mc_blog/why_add_q_to_mc_blog.ipynb
      - 2020 Bayesian Optimization Expected Improvement:
        - qEI: demos/qei-demo-for-blog.ipynb
        - Noisy EI: demos/nei_demo.ipynb
    - Multilevel (Quasi-)Monte Carlo:
      - Single and Multilevel (Q)MC for an Elliptic PDE: demos/elliptic-pde.ipynb
      - Multilevel (Q)MC for Option Pricing: demos/asian-option-mlqmc.ipynb
    - Links and Comparisons with Existing Software:
      - UM-Bridge: demos/umbridge.ipynb
      - DAKOTA Halton Points: demos/DAKOTA_Genz/dakota_genz.ipynb
    - Plotting:
      - Plotting Points Automatically: demos/plot_proj_function.ipynb
      - Plotting Points Manually: demos/sample_scatter_plots.ipynb
      - QMCPy Logo: demos/qmcpy-logo.ipynb
    - Algorithm Testing:
      - Digital Nets in Base 2 and their Randomizations: demos/digital_net_b2.ipynb
      - Halton Points and their Randomizations: demos/linear-scrambled-halton.ipynb
      - Latin Hypercube, Korobov Lattice, and Hammersley Samplers: demos/korobov_hammersley_latinhypercube_demos.ipynb
      - Geometric Brownian Motion: demos/GBM/gbm_demo.ipynb
      - GBM Examples: demos/GBM/gbm_examples.ipynb
      - Brownian Bridge: demos/brownian_bridge.ipynb
      - Control Variates: demos/control_variates.ipynb
      - Sensitivity Analysis for the Iris Dataset: demos/iris.ipynb
      - Ray Tracing: demos/ray_tracing.ipynb
      - Importance Sampling with True Measures:
        - Statistics for True Measures: demos/statistics_for_TrueMeasure.ipynb
        - Some True Measures: demos/some_true_measures.ipynb
        - SciPyWrapper dependence and Custom distributions: demos/scipywrapper_dependence_custom/scipywrapper_demo.ipynb
        - ProductMeasure: demos/product_measure.ipynb
        - Acceptance-Rejection Sampling: demos/acceptance_rejection.ipynb
        - Copula TrueMeasure Examples: demos/copula_examples.ipynb
  - For Developers:
    - Release Manual: RELEASE.md
    - Contribution Good Practices: good_practices.md
    - AI-Assisted Contributions: ai-assisted-contributions.md
    - Testing Guidelines:
      - Local doc tests and unit tests on `qmcpy`: tests.md
      - CI testing and cost control: ci-testing.md
      - QMCPy MPMC compatibility matrix: mpmc-compatibility.md
      - Unit tests on Jupyter Notebooks: booktests.md
      - Coding Agents: AGENTS.md
    - JOSS 2026 Paper: paper/paper.md


plugins:
  - material/search
  - mkdocs-jupyter:
      ignore_h1_titles: true       # Ignore H1 titles from notebooks
      execute: false               # Execute notebooks during build
      include_source: true         # Add download link for source notebooks
      include: ["*.ipynb"]       # Restrict plugin to notebooks; avoid parsing API markdown
      # theme: dark                # Use dark theme for code cells
      # execute_ignore: []         # Skip certain files
      # allow_errors: false        # Fail build on notebook errors
      # kernel_name: python3       # Specify kernel to use
      # show_input: true           # Show input cells by default
      # no_input: false            # Don't hide all inputs
      # remove_tag_config:
      #   remove_cell_tags:
      #     - "hide"               # Hide cells with these tags
      #     - "hide-cell"
      #   remove_all_outputs_tags:
      #     - "hide-output"        # Hide outputs for tagged cells
      #   remove_input_tags:
      #     - "hide-input"         # Hide input for tagged cells
  - mkdocstrings:
      #enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
      #custom_templates: templates
      default_handler: python
      handlers:
        python:
          paths: [.]  # project root must be on sys.path for `import qmcpy` to work under the `mkdocs` entrypoint
          options:
            members_order: source
            show_root_toc_entry: false
            heading_level: 3
            docstring_section_style: table
            separate_signature: true
            line_length: 50
            show_submodules: true
            docstring_style: google
            docstring_options:
              ignore_init_summary: false
            merge_init_into_class: true
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      slide_effect: zoom
      width: 100%
      height: auto
      zoomable: true
      draggable: false
      skip_classes:
        - custom-skip-class-name
      auto_caption: false
      caption_position: bottom
      background: white
      shadow: true
      manual: false
  - autorefs  # explicitly listed so print-site stays last (mkdocstrings auto-injects this)
  # I have commented out the following as it requires storing over 100mb of data, which GitHub throws an error for:
  #         remote: error: File print_page/index.html is 103.75 MB; this exceeds GitHub's file size limit of 100.00 MB
  # - print-site:  # Enables PDF generation (saves docs to print_page/). See https://tinyurl.com/52ba83ax
  #     add_to_navigation: true

theme:
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
      primary: cyan
    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
      primary: cyan
  name: material
  navigation_depth: 6
  color_mode: auto
  user_color_mode_toggle: True
  features:
    # - navigation.instant
    - navigation.expand
    - toc.follow
    - navigation.sections
    - toc.integrate
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
  icon:
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
markdown_extensions:
  - toc
  - attr_list
  - admonition
  # - mdx_math
  - extra
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

extra_javascript:
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - stylesheets/paper.css
  - https://unpkg.com/katex@0/dist/katex.min.css