Skip to content

Restructure documentation and add quickstart guide - #3

Merged
dehe1011 merged 2 commits into
devfrom
main
Jun 23, 2026
Merged

Restructure documentation and add quickstart guide#3
dehe1011 merged 2 commits into
devfrom
main

Conversation

@dehe1011

Copy link
Copy Markdown
Owner

Summary

This PR comprehensively restructures the TensorHEOM documentation to improve clarity and user experience. It introduces a new quickstart guide, expands the user guide with detailed examples, reorganizes the API documentation, and updates the main index page with better navigation and feature descriptions.

Key Changes

Documentation Structure

  • New quickstart guide (docs/quickstart.rst): Provides the fastest path from installation to a working simulation, covering both high-level (calcTimeEvo) and low-level (main) APIs with minimal examples
  • Expanded user guide (docs/guide/guide.rst): Transformed from a brief introduction into a comprehensive 300+ line guide with:
    • Four-step workflow overview with ASCII diagram
    • Three detailed examples (single qubit with broadband noise, realistic single-qubit simulation, two-qubit Bell state)
    • Results analysis section with evaluation functions
    • Bath decomposition explanation
    • Hierarchy depth and bond dimension tuning guidance
    • Redfield+ approximation documentation
    • HPC submission instructions
  • Reorganized main index (docs/index.rst):
    • Added version, license, and GitHub links
    • Expanded feature list highlighting non-Markovian dynamics, tensor-train compression, Qiskit integration, and analysis tools
    • Added minimal example code
    • Restructured table of contents with clearer section grouping (Getting Started, User Guide, API Reference, About)
  • Improved GUI documentation (docs/gui/gui.rst): Added launch instructions, better section organization, and improved figure captions
  • Reorganized API documentation (docs/apidoc/apidoc.rst, docs/apidoc/functions.rst, docs/apidoc/classes.rst):
    • Split functions into "Top-level Functions" and "Classes & Module Functions"
    • Added subsections for high-level interface, physical-unit helpers, bath decomposition, and evaluation tools
    • Reordered classes by logical grouping (pulse types, tensor-train, circuit compilation, dynamics, HPC)

Configuration Updates

  • Sphinx configuration (docs/conf.py):
    • Added static files path and logo configuration
    • Added theme options for better navigation (collapse_navigation, sticky_navigation)
    • Added GitHub context for "Edit on GitHub" links
    • Fixed typo: "Syntax highlighing" → "Syntax highlighting"

Source Code Updates

  • Main module (ttheom/main.py): Fixed docstring typo in calcTimeEvo (dtFB unit: "fs" → "ps")
  • Evaluation module (ttheom/evaluation/__init__.py): Added import for logarithmic_negativity module

Notable Implementation Details

  • The quickstart guide uses the high-level calcTimeEvo API with physical units (GHz, ns, mK, µs, ps) for accessibility
  • The user guide demonstrates the low-level main API with internal units and includes helper functions (prepareSystemArgs, prepareBathArgs, prepareGateArgs) for unit conversion
  • Examples progress in complexity: single qubit → realistic single qubit → two-qubit entanglement
  • Documentation now clearly distinguishes between quick-start (high-level) and in-depth (low-level) workflows

https://claude.ai/code/session_013BxsoSLohB7jw2D72nJRpx

claude and others added 2 commits June 23, 2026 07:14
- Rewrite index.rst with project description, feature list, install snippet
  and a minimal working code example
- Add quickstart.rst with step-by-step 1Q and 2Q examples, parameter
  descriptions, and analysis snippets
- Rewrite guide/guide.rst with three worked examples (single-qubit,
  realistic single-qubit, two-qubit Bell state), bath decomposition
  section, convergence guidance, and HPC submission example
- Improve gui/gui.rst with feature descriptions and fixed RST title
- Expand apidoc/functions.rst to include evaluation functions and
  high-level simulation API
- Reorganise apidoc/classes.rst (remove duplicated entries, add sections)
- Fix copyright.rst: replace all qDNA/QuantumDNA references with TensorHEOM
- conf.py: add html_logo, html_theme_options, html_context; remove
  duplicate exclude_patterns and unsupported display_version option
- evaluation/__init__.py: export getLogarithmicNegativity
- main.py: fix dtFB unit in calcTimeEvo docstring (ps, not fs)
- Build passes sphinx -W --keep-going with zero warnings

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013BxsoSLohB7jw2D72nJRpx
@dehe1011
dehe1011 merged commit ce99c50 into dev Jun 23, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants