diff --git a/README.md b/README.md index 60c1966..b7a864e 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,22 @@ Python library for simulation of quantum mechanical systems. -[![.github/workflows/build_docs.yml](https://github.com/viljarjf/QM_sim/actions/workflows/build_docs.yml/badge.svg?branch=main&event=page_build)](https://github.com/viljarjf/QM_sim/actions/workflows/build_docs.yml) +[![Build docs](https://github.com/viljarjf/QM_sim/actions/workflows/build_docs.yml/badge.svg)](https://github.com/viljarjf/QM_sim/actions/workflows/build_docs.yml) + +[//]: # (This is a comment. This comment should be on line 7. If this changes, also change the hard-coded line number for the start-line for the mdinclude at the top of docs/source/index.rst ) ## Features -- 1D and 2D systems +- 1D, 2D, and 3D systems - Choice of finite difference scheme +- Zero and periodic boundary conditions - Stationary and temporal solutions - Plots ## Planned features -- Boundary conditions -- 3D systems - Transfer matrix for transmission ect. -- Testing +- Proper testing + +[//]: # (This is a comment. This comment should be on line 20. If this changes, also change the hard-coded line number for the end-line for the mdinclude at the top of docs/source/index.rst ) ## Installation diff --git a/docs/source/conf.py b/docs/source/conf.py index d68fe7f..0717c45 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -20,6 +20,7 @@ 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.viewcode', + 'sphinx_mdinclude' ] diff --git a/docs/source/examples.rst b/docs/source/examples.rst index a777f44..8b0eb32 100644 --- a/docs/source/examples.rst +++ b/docs/source/examples.rst @@ -36,3 +36,9 @@ Temporal evolution of a 2D system .. literalinclude:: ../../examples/06_2D_temporal_evolution.py :language: python + +Hydrogen atom +--------------------------------- + +.. literalinclude:: ../../examples/07_hydrogen_atom.py + :language: python diff --git a/docs/source/index.rst b/docs/source/index.rst index 5843855..267493e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,24 +3,15 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Python library for simulation of quantum mechanical systems. -============================================================ - -Features --------- - -- 1D and 2D systems -- Choice of finite difference scheme -- Stationary and temporal solutions -- Plots -- CPU and GPU calculations - -Planned features ----------------- -- Boundary conditions -- 3D systems -- Transfer matrix for transmission ect. -- Testing +QM-sim +====== + +A python library for simulation of quantum mechanical systems. + + +.. mdinclude:: ../../README.md + :start-line: 7 + :end-line: 20 .. toctree:: :maxdepth: 1 diff --git a/pyproject.toml b/pyproject.toml index 02bb9e8..a302aa2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -30,7 +30,7 @@ dependencies = [ [project.optional-dependencies] test = ["pytest", "matplotlib"] torch = ["torch"] -docs = ["sphinx", "sphinx-rtd-theme"] +docs = ["sphinx", "sphinx-rtd-theme", "sphinx-mdinclude"] [build-system] requires = [