Merge branch 'develop' into deps/bump

jlnav · jlnav · commit d36b08c31b81 · 2026-05-13T08:44:05.000-05:00
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -26,6 +26,9 @@ build:
     - pixi run -e docs build-docs
     - mkdir -p $READTHEDOCS_OUTPUT/html/
     - cp -r docs/_build/html/** $READTHEDOCS_OUTPUT/html/
+    - pixi run -e docs build-pdf
+    - mkdir -p $READTHEDOCS_OUTPUT/pdf/
+    - cp -r docs/_build/latex/libEnsemble.pdf $READTHEDOCS_OUTPUT/pdf/
 
 sphinx:
     configuration: docs/conf.py
diff --git a/README.rst b/README.rst
@@ -25,9 +25,13 @@ and inference problems on the world's leading supercomputers such as Frontier, A
 **New:** libEnsemble nows supports the `gest-api`_ generator standard, and can run with
 Optimas and Xopt generators.
 
-The |ScriptCreator| to generate customized scripts for running ensembles with your
+.. before_script_creator_tag
+
+Try the |ScriptCreator| to generate customized scripts for running ensembles with your
 MPI applications.
 
+.. after_script_creator_tag
+
 Installation
 ============
 
@@ -109,6 +113,8 @@ and an exit condition.
         ensemble.save_output(__file__)
         print("Some output data:\n", ensemble.H[["x0", "x1", "f"]][:10])
 
+.. before_colab_tag
+
 |Inline Example|
 
 Try some other examples live in Colab.
@@ -127,6 +133,8 @@ Try some other examples live in Colab.
 | Bayesian Optimization with Xopt.                              | |Bayesian Optimization with Xopt|   |
 +---------------------------------------------------------------+-------------------------------------+
 
+.. after_colab_tag
+
 There are many more examples in the `regression tests`_ and `Community Examples repository`_.
 
 Resources
@@ -216,6 +224,6 @@ Resources
 .. |Bayesian Optimization with Xopt| image:: https://colab.research.google.com/assets/colab-badge.svg
   :target:  https://colab.research.google.com/github/Libensemble/libensemble/blob/develop/examples/tutorials/xopt_bayesian_gen/xopt_EI_example.ipynb
 
-.. |ScriptCreator| image:: https://img.shields.io/badge/Script_Creator-purple?logo=magic
+.. |ScriptCreator| image:: https://img.shields.io/badge/Script_Creator-purple
    :target: https://libensemble.github.io/script-creator/
    :alt: Script Creator
diff --git a/docs/conf.py b/docs/conf.py
@@ -91,7 +91,6 @@ class AxParameterWarning(Warning):  # Ensure it's a real warning subclass
     "sphinx.ext.napoleon",
     # 'sphinx.ext.autosectionlabel',
     "sphinx.ext.intersphinx",
-    "sphinx.ext.imgconverter",
     "sphinx.ext.mathjax",
     "sphinxcontrib.autodoc_pydantic",
     "sphinx_design",
diff --git a/docs/introduction.rst b/docs/introduction.rst
@@ -1,5 +1,13 @@
 .. include:: ../README.rst
     :start-after: after_badges_rst_tag
+    :end-before: before_script_creator_tag
+
+.. include:: ../README.rst
+    :start-after: after_script_creator_tag
+    :end-before: before_colab_tag
+
+.. include:: ../README.rst
+    :start-after: after_colab_tag
 
 See the :doc:`tutorial<tutorials/local_sine_tutorial/local_sine_tutorial>` for a step-by-step beginners guide.
 
diff --git a/docs/tutorials/aposmm_tutorial.rst b/docs/tutorials/aposmm_tutorial.rst
@@ -10,7 +10,9 @@ simulation :ref:`sim_f<funcguides-sim>` that defines a function with
 multiple minima, then write a libEnsemble calling script that imports APOSMM and
 parameterizes it to check for minima over a domain of outputs from our ``sim_f``.
 
-|Open in Colab|
+.. only:: html
+
+    |Open in Colab|
 
 Six-Hump Camel Simulation Function
 ----------------------------------
diff --git a/docs/tutorials/executor_forces_tutorial.rst b/docs/tutorials/executor_forces_tutorial.rst
@@ -6,7 +6,9 @@ This tutorial highlights libEnsemble's capability to portably execute
 and monitor external scripts or user applications within simulation or generator
 functions using the :doc:`executor<../executor/ex_index>`.
 
-|Open in Colab|
+.. only:: html
+
+    |Open in Colab|
 
 The calling script registers a compiled executable that simulates
 electrostatic forces between a collection of particles. The simulator function
diff --git a/docs/tutorials/gpcam_tutorial.rst b/docs/tutorials/gpcam_tutorial.rst
@@ -5,7 +5,9 @@ This example uses gpCAM_ to construct a global surrogate of ``f`` values using a
 
 In each iteration, a batch of points is produced for concurrent evaluation, maximizing uncertainty reduction.
 
-|Open in Colab|
+.. only:: html
+
+    |Open in Colab|
 
 Ensure that libEnsemble, and gpCAM are installed via: ``pip install libensemble gpcam``
 
diff --git a/docs/tutorials/local_sine_tutorial/local_sine_tutorial.rst b/docs/tutorials/local_sine_tutorial/local_sine_tutorial.rst
@@ -9,7 +9,10 @@ calculations in parallel using :doc:`libEnsemble<../../introduction>`.
 
 We recommend reading this brief :doc:`Overview<../../overview_usecases>`.
 
-|Open in Colab|
+.. only:: html
+
+    |Open in Colab|
+
 
 For this tutorial, our generator will produce uniform randomly sampled
 values, and our simulator will calculate the sine of each. By default we don't
diff --git a/docs/tutorials/xopt_bayesian_gen.rst b/docs/tutorials/xopt_bayesian_gen.rst
@@ -10,7 +10,9 @@ We'll show two approaches:
 1. Using an xopt-style simulator (callable function)
 2. Using a libEnsemble-style simulator function
 
-|Open in Colab|
+.. only:: html
+
+    |Open in Colab|
 
 Imports
 -------
diff --git a/pixi.lock b/pixi.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -138,10 +138,17 @@ mypy = ">=1.19.1,<2"
 types-psutil = ">=6.1.0.20241221,<7"
 types-pyyaml = ">=6.0.12.20250915,<7"
 furo = ">=2025.12.19,<2026"
+latexcodec = ">=2.0.1,<3"
+latexmk = ">=4.88,<5"
+fonts-conda-forge = ">=1,<2"
+imagemagick = ">=7.1.2_16,<8"
 
 [tool.pixi.tasks.build-docs]
 cmd = "cd docs && make html"
 
+[tool.pixi.tasks.build-pdf]
+cmd = "cd docs && make latexpdf"
+
 # Linux dependencies, only for extra tests
 [tool.pixi.feature.extra.target.linux-64.dependencies]
 scikit-build = "*"
