From 8095df3b74b0c918915969f9af595a14183d79ff Mon Sep 17 00:00:00 2001 From: Brian Doolittle Date: Thu, 15 Jul 2021 10:41:19 -0400 Subject: [PATCH] initial docs commit --- docs/Makefile | 20 +++++++++++ docs/build/.gitignore | 4 +++ docs/environment.yml | 6 ++++ docs/make.bat | 35 +++++++++++++++++++ docs/source/conf.py | 55 ++++++++++++++++++++++++++++++ docs/source/index.rst | 20 +++++++++++ test/chsh_gradient_descent_test.py | 2 +- 7 files changed, 141 insertions(+), 1 deletion(-) create mode 100644 docs/Makefile create mode 100644 docs/build/.gitignore create mode 100644 docs/environment.yml create mode 100644 docs/make.bat create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/build/.gitignore b/docs/build/.gitignore new file mode 100644 index 0000000..86d0cb2 --- /dev/null +++ b/docs/build/.gitignore @@ -0,0 +1,4 @@ +# Ignore everything in this directory +* +# Except this file +!.gitignore \ No newline at end of file diff --git a/docs/environment.yml b/docs/environment.yml new file mode 100644 index 0000000..4bfc45d --- /dev/null +++ b/docs/environment.yml @@ -0,0 +1,6 @@ +name: pennylane-nonlocality-docs +channels: + - defaults +dependencies: + - python=3.8 + - sphinx diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..6247f7e --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..bbb3163 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,55 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'QNetOptimizer' +copyright = '2021, Brian Doolittle and Tom Bromley' +author = 'Brian Doolittle and Tom Bromley' + +# The full version, including alpha/beta/rc tags +release = '0.1' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..cbdec0d --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,20 @@ +.. QNetOptimizer documentation master file, created by + sphinx-quickstart on Thu Jul 15 10:27:48 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to QNetOptimizer's documentation! +========================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/test/chsh_gradient_descent_test.py b/test/chsh_gradient_descent_test.py index 2aed4d8..81a506a 100644 --- a/test/chsh_gradient_descent_test.py +++ b/test/chsh_gradient_descent_test.py @@ -52,6 +52,6 @@ def chsh_cost(scenario_settings): np.random.seed(666) init_settings = chsh_ansatz.rand_scenario_settings() - opt_dict = QNopt.gradient_descent(chsh_cost, init_settings, verbose=False) + opt_dict = QNopt.gradient_descent(chsh_cost, init_settings, num_steps=40, verbose=False) assert np.isclose(opt_dict["opt_score"], 2 * np.sqrt(2), atol=1e-5)