Conversation
- 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
Claude/modest sagan 4m94q0
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
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 examplesdocs/guide/guide.rst): Transformed from a brief introduction into a comprehensive 300+ line guide with:docs/index.rst):docs/gui/gui.rst): Added launch instructions, better section organization, and improved figure captionsdocs/apidoc/apidoc.rst,docs/apidoc/functions.rst,docs/apidoc/classes.rst):Configuration Updates
docs/conf.py):Source Code Updates
ttheom/main.py): Fixed docstring typo incalcTimeEvo(dtFB unit: "fs" → "ps")ttheom/evaluation/__init__.py): Added import forlogarithmic_negativitymoduleNotable Implementation Details
calcTimeEvoAPI with physical units (GHz, ns, mK, µs, ps) for accessibilitymainAPI with internal units and includes helper functions (prepareSystemArgs,prepareBathArgs,prepareGateArgs) for unit conversionhttps://claude.ai/code/session_013BxsoSLohB7jw2D72nJRpx