Docs/tutorial solutions/exercises

README.rst

@@ -25,7 +25,7 @@
 Introduction to libEnsemble
 ===========================
 
-libEnsemble is a Python_ toolkit for coordinating asynchronous and dynamic ensembles of calculations.
+libEnsemble is a Python_ toolkit for coordinating workflows of asynchronous and dynamic ensembles of calculations.
 
 libEnsemble can help users take advantage of massively parallel resources to solve design,
 decision, and inference problems and expand the class of problems that can benefit from
@@ -258,6 +258,8 @@ Resources
 
 **Example Compatible Packages**
 
+.. before_examples_rst_tag
+
 libEnsemble and the `Community Examples repository`_ include example generator
 functions for the following libraries:
 

docs/examples/gen_funcs.rst

@@ -1,17 +1,15 @@
 Generation Functions
 ====================
 
-Below are example generation functions available in libEnsemble.
-
-Additional examples are available in the `libEnsemble Community Repository`_,
-with corresponding generator documentation available :doc:`here<community:index>`.
+.. include:: ../../README.rst
+    :start-after: before_examples_rst_tag
 
 .. IMPORTANT::
   See the API for generation functions :ref:`here<api_gen_f>`.
 
 .. toctree::
    :maxdepth: 2
-   :caption: Example Generator Functions:
+   :caption: Documented Example Generator Functions:
 
    sampling
    aposmm

docs/executor/overview.rst

@@ -19,7 +19,7 @@ Python's native `concurrent futures`_ interface. Executors feature the ``submit(
 function for launching apps (detailed below),  but currently do not support
 ``map()`` or ``shutdown()``. Tasks are much like ``futures``, except they correspond
 to an application instance instead of a callable. They feature the ``cancel()``,
-``cancelled()``, ``running()``,``done()``, ``result()``, and ``exception()`` functions
+``cancelled()``, ``running()``, ``done()``, ``result()``, and ``exception()`` functions
 from the standard.
 
 The main ``Executor`` class is an abstract class, inherited by the ``MPIExecutor``

docs/history_output_logging.rst

@@ -60,6 +60,8 @@ stderr displaying can be effectively disabled by setting the stderr level to CRI
   :members:
   :no-undoc-members:
 
+.. _output_dirs:
+
 Working Directories for User Functions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 libEnsemble features configurable output and working directory structuring for

docs/tutorials/aposmm_tutorial.rst

@@ -274,6 +274,8 @@ APOSMM with libEnsemble should be listed directly below the warning.
 Please see the API reference :doc:`here<../examples/aposmm>` for
 more APOSMM configuration options and other information.
 
+Each of these example files can be found in the repository in `examples/tutorials/aposmm`_.
+
 Applications
 ------------
 
@@ -289,3 +291,4 @@ can be found in libEnsemble's `WarpX Scaling Test`_.
 .. _`PETSc/TAO`: https://www.mcs.anl.gov/petsc/
 .. _SciPy: https://www.scipy.org/scipylib/index.html
 .. _`WarpX Scaling Test`: https://github.com/Libensemble/libensemble/tree/master/libensemble/tests/scaling_tests/warpx
+.. _examples/tutorials/aposmm: https://github.com/Libensemble/libensemble/tree/develop/examples/tutorials