Skip to content

Commit

Permalink
Update sim funcs examples
Browse files Browse the repository at this point in the history
  • Loading branch information
shuds13 committed Feb 21, 2025
1 parent a2839fa commit 900584b
Show file tree
Hide file tree
Showing 15 changed files with 235 additions and 41 deletions.
1 change: 0 additions & 1 deletion docs/examples/gen_funcs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
77 changes: 37 additions & 40 deletions docs/examples/sim_funcs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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


16 changes: 16 additions & 0 deletions docs/examples/sim_funcs/borehole.rst
Original file line number Diff line number Diff line change
@@ -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:
16 changes: 16 additions & 0 deletions docs/examples/sim_funcs/borehole_kills.rst
Original file line number Diff line number Diff line change
@@ -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:
15 changes: 15 additions & 0 deletions docs/examples/sim_funcs/chwirut1.rst
Original file line number Diff line number Diff line change
@@ -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:
15 changes: 15 additions & 0 deletions docs/examples/sim_funcs/forces_simf.rst
Original file line number Diff line number Diff line change
@@ -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:
15 changes: 15 additions & 0 deletions docs/examples/sim_funcs/inverse_bayes.rst
Original file line number Diff line number Diff line change
@@ -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:
16 changes: 16 additions & 0 deletions docs/examples/sim_funcs/mock_sim.rst
Original file line number Diff line number Diff line change
@@ -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:
15 changes: 15 additions & 0 deletions docs/examples/sim_funcs/noisy_vector_mapping.rst
Original file line number Diff line number Diff line change
@@ -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:
15 changes: 15 additions & 0 deletions docs/examples/sim_funcs/periodic_func.rst
Original file line number Diff line number Diff line change
@@ -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:
15 changes: 15 additions & 0 deletions docs/examples/sim_funcs/rosenbrock.rst
Original file line number Diff line number Diff line change
@@ -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:
15 changes: 15 additions & 0 deletions docs/examples/sim_funcs/simple_sim.rst
Original file line number Diff line number Diff line change
@@ -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:
15 changes: 15 additions & 0 deletions docs/examples/sim_funcs/six_hump_camel.rst
Original file line number Diff line number Diff line change
@@ -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:
15 changes: 15 additions & 0 deletions docs/examples/sim_funcs/surmise_test_function.rst
Original file line number Diff line number Diff line change
@@ -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:
15 changes: 15 additions & 0 deletions docs/examples/sim_funcs/var_resources.rst
Original file line number Diff line number Diff line change
@@ -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:

0 comments on commit 900584b

Please sign in to comment.