Skip to content

Commit 900584b

Browse files
shuds13shuds13
committed
Update sim funcs examples
1 parent a2839fa commit 900584b

15 files changed

+235
-41
lines changed

‎docs/examples/gen_funcs.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,6 @@ Modeling and Approximation
114114
Distributed evolutionary algorithms (*community example*)
115115

116116

117-
118117
.. _libEnsemble Community Repository: https://github.com/Libensemble/libe-community-examples
119118

120119
.. _APOSMM: https://link.springer.com/article/10.1007/s12532-017-0131-4

‎docs/examples/sim_funcs.rst‎

Lines changed: 37 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -13,43 +13,40 @@ function launching tasks, see the
1313
.. role:: underline
1414
:class: underline
1515

16-
six_hump_camel
17-
--------------
18-
.. automodule:: six_hump_camel
19-
:members: six_hump_camel_simple, persistent_six_hump_camel
20-
:undoc-members:
21-
22-
.. dropdown:: :underline:`six_hump_camel.py`
23-
24-
.. literalinclude:: ../../libensemble/sim_funcs/six_hump_camel.py
25-
:language: python
26-
:linenos:
27-
28-
noisy_vector_mapping
29-
--------------------
30-
.. automodule:: noisy_vector_mapping
31-
:members:
32-
:undoc-members:
33-
34-
.. dropdown:: :underline:`noisy_vector_mapping.py`
35-
36-
.. literalinclude:: ../../libensemble/sim_funcs/noisy_vector_mapping.py
37-
:language: python
38-
:linenos:
39-
40-
borehole
41-
--------
42-
.. automodule:: borehole
43-
:members:
44-
:undoc-members:
45-
46-
executor_hworld
47-
---------------
48-
.. automodule:: executor_hworld
49-
:members:
50-
51-
.. dropdown:: :underline:`executor_hworld.py`
52-
53-
.. literalinclude:: ../../libensemble/sim_funcs/executor_hworld.py
54-
:language: python
55-
:linenos:
16+
17+
Simple simulation functions
18+
---------------------------
19+
20+
.. toctree::
21+
:maxdepth: 1
22+
23+
sim_funcs/simple_sim
24+
sim_funcs/borehole
25+
sim_funcs/borehole_kills
26+
sim_funcs/chwirut1
27+
sim_funcs/inverse_bayes
28+
sim_funcs/noisy_vector_mapping
29+
sim_funcs/periodic_func
30+
sim_funcs/rosenbrock
31+
sim_funcs/six_hump_camel
32+
sim_funcs/surmise_test_function
33+
34+
35+
Functions with CPU/GPU allocation
36+
---------------------------------
37+
38+
.. toctree::
39+
:maxdepth: 1
40+
41+
sim_funcs/var_resources
42+
sim_funcs/forces_simf
43+
44+
Special simulation functions
45+
----------------------------
46+
47+
.. toctree::
48+
:maxdepth: 1
49+
50+
sim_funcs/mock_sim
51+
52+

‎docs/examples/sim_funcs/borehole.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
borehole
2+
--------------
3+
.. role:: underline
4+
:class: underline
5+
6+
.. automodule:: borehole
7+
:members:
8+
:undoc-members:
9+
10+
.. dropdown:: :underline:`borehole.py`
11+
12+
13+
14+
.. literalinclude:: ../../../libensemble/sim_funcs/borehole.py
15+
:language: python
16+
:linenos:

‎docs/examples/sim_funcs/borehole_kills.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
borehole_kills
2+
--------------
3+
.. role:: underline
4+
:class: underline
5+
6+
.. automodule:: borehole_kills
7+
:members:
8+
:undoc-members:
9+
10+
.. dropdown:: :underline:`borehole_kills.py`
11+
12+
13+
14+
.. literalinclude:: ../../../libensemble/sim_funcs/borehole_kills.py
15+
:language: python
16+
:linenos:

‎docs/examples/sim_funcs/chwirut1.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
chwirut1
2+
--------------
3+
.. role:: underline
4+
:class: underline
5+
6+
.. automodule:: chwirut1
7+
:members:
8+
:undoc-members:
9+
10+
.. dropdown:: :underline:`chwirut1.py`
11+
12+
13+
.. literalinclude:: ../../../libensemble/sim_funcs/chwirut1.py
14+
:language: python
15+
:linenos:

‎docs/examples/sim_funcs/forces_simf.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
forces_simf
2+
--------------
3+
.. role:: underline
4+
:class: underline
5+
6+
.. automodule:: forces_simf
7+
:members:
8+
:undoc-members:
9+
10+
.. dropdown:: :underline:`forces_simf.py`
11+
12+
13+
.. literalinclude:: ../../../libensemble/sim_funcs/forces_simf.py
14+
:language: python
15+
:linenos:

‎docs/examples/sim_funcs/inverse_bayes.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
inverse_bayes
2+
--------------
3+
.. role:: underline
4+
:class: underline
5+
6+
.. automodule:: inverse_bayes
7+
:members:
8+
:undoc-members:
9+
10+
.. dropdown:: :underline:`inverse_bayes.py`
11+
12+
13+
.. literalinclude:: ../../../libensemble/sim_funcs/inverse_bayes.py
14+
:language: python
15+
:linenos:

‎docs/examples/sim_funcs/mock_sim.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
mock_sim (re-run using history file)
2+
------------------------------------
3+
4+
.. role:: underline
5+
:class: underline
6+
7+
.. automodule:: mock_sim
8+
:members:
9+
:undoc-members:
10+
11+
.. dropdown:: :underline:`mock_sim.py`
12+
13+
14+
.. literalinclude:: ../../../libensemble/sim_funcs/mock_sim.py
15+
:language: python
16+
:linenos:

‎docs/examples/sim_funcs/noisy_vector_mapping.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
noisy_vector_mapping
2+
--------------
3+
.. role:: underline
4+
:class: underline
5+
6+
.. automodule:: noisy_vector_mapping
7+
:members:
8+
:undoc-members:
9+
10+
.. dropdown:: :underline:`noisy_vector_mapping.py`
11+
12+
13+
.. literalinclude:: ../../../libensemble/sim_funcs/noisy_vector_mapping.py
14+
:language: python
15+
:linenos:

‎docs/examples/sim_funcs/periodic_func.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
periodic_func
2+
--------------
3+
.. role:: underline
4+
:class: underline
5+
6+
.. automodule:: periodic_func
7+
:members:
8+
:undoc-members:
9+
10+
.. dropdown:: :underline:`periodic_func.py`
11+
12+
13+
.. literalinclude:: ../../../libensemble/sim_funcs/periodic_func.py
14+
:language: python
15+
:linenos:

0 commit comments

Comments
 (0)