Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Emulator fix doc #101

Merged
merged 10 commits into from
Mar 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/source/_static/suzuki_reizman.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 9 additions & 5 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,8 @@
"sphinx.ext.intersphinx",
# read the docs theme
"sphinx_rtd_theme",
# show plots
"matplotlib.sphinxext.mathmpl",
"matplotlib.sphinxext.plot_directive",
# Doctest
"sphinx.ext.doctest",
# Redirects
"sphinx_reredirects",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -116,6 +113,13 @@ def linkcode_resolve(domain, info):
return "https://somesite/sourcerepo/%s.py" % filename


# -- Options for redirects----------------------------------------------------

redirects = {
"tutorial": "tutorials/intro.html",
"experiments_benchmarks/new_benchmarks": "../tutorials/new_benchmarks.html",
}

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand Down
3 changes: 3 additions & 0 deletions docs/source/experiments_benchmarks/experimental_emulator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,7 @@ Experimental Emulator API


.. autoclass:: summit.benchmarks.ANNRegressor
:members:

.. autoclass:: summit.benchmarks.RegressorRegistry
:members:
7 changes: 3 additions & 4 deletions docs/source/experiments_benchmarks/index.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
Experiments / Benchmarks
========================

The :class:`~summit.experiment.Experiment` class provides a generic way of representing chemical reactions, virtual or real. We leverage this class to create the benchmarks available here. To get some insight into how to hook Summit up to real experimetns, look at the tutorial_.
The :class:`~summit.experiment.Experiment` class provides a generic way of representing chemical reactions, virtual or real. We leverage this class to create the benchmarks available in Summit. You can also create your own benchmarks based on experimental data (see here_). To get some insight into how to hook Summit up to real experiments, look at the introductory tutorial_.

Here, we present the already implemented benchmarks and show you how to create new onces.

.. _tutorial: ../tutorial.ipynb
.. _new_benchmarks: new_benchmarks.rst
.. _here: ../tutorials/new_benchmarks.ipynb
.. _tutorial: ../tutorials/tutorial.ipynb

.. toctree::
implemented_benchmarks
new_benchmarks
experiment
experimental_emulator
329 changes: 0 additions & 329 deletions docs/source/experiments_benchmarks/new_benchmarks.ipynb

This file was deleted.

2 changes: 2 additions & 0 deletions docs/source/experiments_benchmarks/new_benchmarks.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
..
This a placeholder file to redirect stale links to the new tutorials directory.
Loading