From 900584bc2585622186f07e7c5dd1c4df57fd2d0b Mon Sep 17 00:00:00 2001 From: shudson Date: Fri, 21 Feb 2025 12:03:31 -0600 Subject: [PATCH] Update sim funcs examples --- docs/examples/gen_funcs.rst | 1 - docs/examples/sim_funcs.rst | 77 +++++++++---------- docs/examples/sim_funcs/borehole.rst | 16 ++++ docs/examples/sim_funcs/borehole_kills.rst | 16 ++++ docs/examples/sim_funcs/chwirut1.rst | 15 ++++ docs/examples/sim_funcs/forces_simf.rst | 15 ++++ docs/examples/sim_funcs/inverse_bayes.rst | 15 ++++ docs/examples/sim_funcs/mock_sim.rst | 16 ++++ .../sim_funcs/noisy_vector_mapping.rst | 15 ++++ docs/examples/sim_funcs/periodic_func.rst | 15 ++++ docs/examples/sim_funcs/rosenbrock.rst | 15 ++++ docs/examples/sim_funcs/simple_sim.rst | 15 ++++ docs/examples/sim_funcs/six_hump_camel.rst | 15 ++++ .../sim_funcs/surmise_test_function.rst | 15 ++++ docs/examples/sim_funcs/var_resources.rst | 15 ++++ 15 files changed, 235 insertions(+), 41 deletions(-) create mode 100644 docs/examples/sim_funcs/borehole.rst create mode 100644 docs/examples/sim_funcs/borehole_kills.rst create mode 100644 docs/examples/sim_funcs/chwirut1.rst create mode 100644 docs/examples/sim_funcs/forces_simf.rst create mode 100644 docs/examples/sim_funcs/inverse_bayes.rst create mode 100644 docs/examples/sim_funcs/mock_sim.rst create mode 100644 docs/examples/sim_funcs/noisy_vector_mapping.rst create mode 100644 docs/examples/sim_funcs/periodic_func.rst create mode 100644 docs/examples/sim_funcs/rosenbrock.rst create mode 100644 docs/examples/sim_funcs/simple_sim.rst create mode 100644 docs/examples/sim_funcs/six_hump_camel.rst create mode 100644 docs/examples/sim_funcs/surmise_test_function.rst create mode 100644 docs/examples/sim_funcs/var_resources.rst diff --git a/docs/examples/gen_funcs.rst b/docs/examples/gen_funcs.rst index bb5eb4835..9452bf306 100644 --- a/docs/examples/gen_funcs.rst +++ b/docs/examples/gen_funcs.rst @@ -114,7 +114,6 @@ Modeling and Approximation Distributed evolutionary algorithms (*community example*) - .. _libEnsemble Community Repository: https://github.com/Libensemble/libe-community-examples .. _APOSMM: https://link.springer.com/article/10.1007/s12532-017-0131-4 diff --git a/docs/examples/sim_funcs.rst b/docs/examples/sim_funcs.rst index be7624c38..cf8d8f105 100644 --- a/docs/examples/sim_funcs.rst +++ b/docs/examples/sim_funcs.rst @@ -13,43 +13,40 @@ function launching tasks, see the .. role:: underline :class: underline -six_hump_camel --------------- -.. automodule:: six_hump_camel - :members: six_hump_camel_simple, persistent_six_hump_camel - :undoc-members: - -.. dropdown:: :underline:`six_hump_camel.py` - - .. literalinclude:: ../../libensemble/sim_funcs/six_hump_camel.py - :language: python - :linenos: - -noisy_vector_mapping --------------------- -.. automodule:: noisy_vector_mapping - :members: - :undoc-members: - -.. dropdown:: :underline:`noisy_vector_mapping.py` - - .. literalinclude:: ../../libensemble/sim_funcs/noisy_vector_mapping.py - :language: python - :linenos: - -borehole --------- -.. automodule:: borehole - :members: - :undoc-members: - -executor_hworld ---------------- -.. automodule:: executor_hworld - :members: - -.. dropdown:: :underline:`executor_hworld.py` - - .. literalinclude:: ../../libensemble/sim_funcs/executor_hworld.py - :language: python - :linenos: + +Simple simulation functions +--------------------------- + +.. toctree:: + :maxdepth: 1 + + sim_funcs/simple_sim + sim_funcs/borehole + sim_funcs/borehole_kills + sim_funcs/chwirut1 + sim_funcs/inverse_bayes + sim_funcs/noisy_vector_mapping + sim_funcs/periodic_func + sim_funcs/rosenbrock + sim_funcs/six_hump_camel + sim_funcs/surmise_test_function + + +Functions with CPU/GPU allocation +--------------------------------- + +.. toctree:: + :maxdepth: 1 + + sim_funcs/var_resources + sim_funcs/forces_simf + +Special simulation functions +---------------------------- + +.. toctree:: + :maxdepth: 1 + + sim_funcs/mock_sim + + diff --git a/docs/examples/sim_funcs/borehole.rst b/docs/examples/sim_funcs/borehole.rst new file mode 100644 index 000000000..fa1293652 --- /dev/null +++ b/docs/examples/sim_funcs/borehole.rst @@ -0,0 +1,16 @@ +borehole +-------------- +.. role:: underline + :class: underline + +.. automodule:: borehole + :members: + :undoc-members: + +.. dropdown:: :underline:`borehole.py` + + + + .. literalinclude:: ../../../libensemble/sim_funcs/borehole.py + :language: python + :linenos: diff --git a/docs/examples/sim_funcs/borehole_kills.rst b/docs/examples/sim_funcs/borehole_kills.rst new file mode 100644 index 000000000..e657a9b4d --- /dev/null +++ b/docs/examples/sim_funcs/borehole_kills.rst @@ -0,0 +1,16 @@ +borehole_kills +-------------- +.. role:: underline + :class: underline + +.. automodule:: borehole_kills + :members: + :undoc-members: + +.. dropdown:: :underline:`borehole_kills.py` + + + + .. literalinclude:: ../../../libensemble/sim_funcs/borehole_kills.py + :language: python + :linenos: diff --git a/docs/examples/sim_funcs/chwirut1.rst b/docs/examples/sim_funcs/chwirut1.rst new file mode 100644 index 000000000..1de202222 --- /dev/null +++ b/docs/examples/sim_funcs/chwirut1.rst @@ -0,0 +1,15 @@ +chwirut1 +-------------- +.. role:: underline + :class: underline + +.. automodule:: chwirut1 + :members: + :undoc-members: + +.. dropdown:: :underline:`chwirut1.py` + + + .. literalinclude:: ../../../libensemble/sim_funcs/chwirut1.py + :language: python + :linenos: diff --git a/docs/examples/sim_funcs/forces_simf.rst b/docs/examples/sim_funcs/forces_simf.rst new file mode 100644 index 000000000..441c6680e --- /dev/null +++ b/docs/examples/sim_funcs/forces_simf.rst @@ -0,0 +1,15 @@ +forces_simf +-------------- +.. role:: underline + :class: underline + +.. automodule:: forces_simf + :members: + :undoc-members: + +.. dropdown:: :underline:`forces_simf.py` + + + .. literalinclude:: ../../../libensemble/sim_funcs/forces_simf.py + :language: python + :linenos: diff --git a/docs/examples/sim_funcs/inverse_bayes.rst b/docs/examples/sim_funcs/inverse_bayes.rst new file mode 100644 index 000000000..c89c85802 --- /dev/null +++ b/docs/examples/sim_funcs/inverse_bayes.rst @@ -0,0 +1,15 @@ +inverse_bayes +-------------- +.. role:: underline + :class: underline + +.. automodule:: inverse_bayes + :members: + :undoc-members: + +.. dropdown:: :underline:`inverse_bayes.py` + + + .. literalinclude:: ../../../libensemble/sim_funcs/inverse_bayes.py + :language: python + :linenos: diff --git a/docs/examples/sim_funcs/mock_sim.rst b/docs/examples/sim_funcs/mock_sim.rst new file mode 100644 index 000000000..3b42b7627 --- /dev/null +++ b/docs/examples/sim_funcs/mock_sim.rst @@ -0,0 +1,16 @@ +mock_sim (re-run using history file) +------------------------------------ + +.. role:: underline + :class: underline + +.. automodule:: mock_sim + :members: + :undoc-members: + +.. dropdown:: :underline:`mock_sim.py` + + + .. literalinclude:: ../../../libensemble/sim_funcs/mock_sim.py + :language: python + :linenos: diff --git a/docs/examples/sim_funcs/noisy_vector_mapping.rst b/docs/examples/sim_funcs/noisy_vector_mapping.rst new file mode 100644 index 000000000..e0a10709e --- /dev/null +++ b/docs/examples/sim_funcs/noisy_vector_mapping.rst @@ -0,0 +1,15 @@ +noisy_vector_mapping +-------------- +.. role:: underline + :class: underline + +.. automodule:: noisy_vector_mapping + :members: + :undoc-members: + +.. dropdown:: :underline:`noisy_vector_mapping.py` + + + .. literalinclude:: ../../../libensemble/sim_funcs/noisy_vector_mapping.py + :language: python + :linenos: diff --git a/docs/examples/sim_funcs/periodic_func.rst b/docs/examples/sim_funcs/periodic_func.rst new file mode 100644 index 000000000..74949a799 --- /dev/null +++ b/docs/examples/sim_funcs/periodic_func.rst @@ -0,0 +1,15 @@ +periodic_func +-------------- +.. role:: underline + :class: underline + +.. automodule:: periodic_func + :members: + :undoc-members: + +.. dropdown:: :underline:`periodic_func.py` + + + .. literalinclude:: ../../../libensemble/sim_funcs/periodic_func.py + :language: python + :linenos: diff --git a/docs/examples/sim_funcs/rosenbrock.rst b/docs/examples/sim_funcs/rosenbrock.rst new file mode 100644 index 000000000..b79072348 --- /dev/null +++ b/docs/examples/sim_funcs/rosenbrock.rst @@ -0,0 +1,15 @@ +rosenbrock +-------------- +.. role:: underline + :class: underline + +.. automodule:: rosenbrock + :members: + :undoc-members: + +.. dropdown:: :underline:`rosenbrock.py` + + + .. literalinclude:: ../../../libensemble/sim_funcs/rosenbrock.py + :language: python + :linenos: diff --git a/docs/examples/sim_funcs/simple_sim.rst b/docs/examples/sim_funcs/simple_sim.rst new file mode 100644 index 000000000..ba203f343 --- /dev/null +++ b/docs/examples/sim_funcs/simple_sim.rst @@ -0,0 +1,15 @@ +simple_sim +-------------- +.. role:: underline + :class: underline + +.. automodule:: simple_sim + :members: + :undoc-members: + +.. dropdown:: :underline:`simple_sim.py` + + + .. literalinclude:: ../../../libensemble/sim_funcs/simple_sim.py + :language: python + :linenos: diff --git a/docs/examples/sim_funcs/six_hump_camel.rst b/docs/examples/sim_funcs/six_hump_camel.rst new file mode 100644 index 000000000..382d70818 --- /dev/null +++ b/docs/examples/sim_funcs/six_hump_camel.rst @@ -0,0 +1,15 @@ +six_hump_camel +-------------- +.. role:: underline + :class: underline + +.. automodule:: six_hump_camel + :members: + :undoc-members: + +.. dropdown:: :underline:`six_hump_camel.py` + + + .. literalinclude:: ../../../libensemble/sim_funcs/six_hump_camel.py + :language: python + :linenos: diff --git a/docs/examples/sim_funcs/surmise_test_function.rst b/docs/examples/sim_funcs/surmise_test_function.rst new file mode 100644 index 000000000..a7bacd8b8 --- /dev/null +++ b/docs/examples/sim_funcs/surmise_test_function.rst @@ -0,0 +1,15 @@ +surmise_test_function +-------------- +.. role:: underline + :class: underline + +.. automodule:: surmise_test_function + :members: + :undoc-members: + +.. dropdown:: :underline:`surmise_test_function.py` + + + .. literalinclude:: ../../../libensemble/sim_funcs/surmise_test_function.py + :language: python + :linenos: diff --git a/docs/examples/sim_funcs/var_resources.rst b/docs/examples/sim_funcs/var_resources.rst new file mode 100644 index 000000000..eb6b28cb1 --- /dev/null +++ b/docs/examples/sim_funcs/var_resources.rst @@ -0,0 +1,15 @@ +var_resources +-------------- +.. role:: underline + :class: underline + +.. automodule:: var_resources + :members: + :undoc-members: + +.. dropdown:: :underline:`var_resources.py` + + + .. literalinclude:: ../../../libensemble/sim_funcs/var_resources.py + :language: python + :linenos: