simoptlib 1.2.4__tar.gz → 1.3.0.dev1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (197) hide show
  1. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/PKG-INFO +39 -120
  2. simoptlib-1.3.0.dev1/README.md +188 -0
  3. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/pyproject.toml +23 -4
  4. simoptlib-1.3.0.dev1/simopt/__main__.py +6 -0
  5. simoptlib-1.3.0.dev1/simopt/_markers.py +15 -0
  6. simoptlib-1.3.0.dev1/simopt/analysis/__init__.py +1 -0
  7. simoptlib-1.3.0.dev1/simopt/analysis/auc.py +233 -0
  8. simoptlib-1.3.0.dev1/simopt/analysis/bootstrap.py +300 -0
  9. simoptlib-1.3.0.dev1/simopt/analysis/common.py +375 -0
  10. simoptlib-1.3.0.dev1/simopt/analysis/deterministic_feasibility_progress.py +190 -0
  11. simoptlib-1.3.0.dev1/simopt/analysis/deterministic_terminal_feasibility.py +258 -0
  12. simoptlib-1.3.0.dev1/simopt/analysis/diff.py +266 -0
  13. simoptlib-1.3.0.dev1/simopt/analysis/feasibility_progress.py +264 -0
  14. simoptlib-1.3.0.dev1/simopt/analysis/merit.py +118 -0
  15. simoptlib-1.3.0.dev1/simopt/analysis/progress_curve.py +229 -0
  16. simoptlib-1.3.0.dev1/simopt/analysis/solvability.py +157 -0
  17. simoptlib-1.3.0.dev1/simopt/analysis/solvability_cdf.py +193 -0
  18. simoptlib-1.3.0.dev1/simopt/analysis/solvability_profile.py +354 -0
  19. simoptlib-1.3.0.dev1/simopt/analysis/terminal_feasibility.py +333 -0
  20. simoptlib-1.3.0.dev1/simopt/analysis/terminal_progress.py +124 -0
  21. simoptlib-1.3.0.dev1/simopt/analysis/terminal_scatterplot.py +133 -0
  22. simoptlib-1.3.0.dev1/simopt/cli.py +59 -0
  23. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/data_farming/data_farming_core.py +1 -2
  24. simoptlib-1.2.4/simopt/experiment_base.py → simoptlib-1.3.0.dev1/simopt/data_farming/design.py +111 -174
  25. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/data_farming/nolhs.py +1 -2
  26. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/data_farming_base.py +13 -25
  27. simoptlib-1.3.0.dev1/simopt/deterministic_feasibility.py +37 -0
  28. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/directory.py +11 -21
  29. simoptlib-1.3.0.dev1/simopt/dsl.py +15 -0
  30. simoptlib-1.3.0.dev1/simopt/experiment/__init__.py +16 -0
  31. simoptlib-1.3.0.dev1/simopt/experiment/api.py +466 -0
  32. simoptlib-1.3.0.dev1/simopt/experiment/data.py +35 -0
  33. simoptlib-1.3.0.dev1/simopt/experiment/experiment.py +146 -0
  34. simoptlib-1.3.0.dev1/simopt/experiment/plot.py +278 -0
  35. simoptlib-1.3.0.dev1/simopt/experiment/post_normalize.py +268 -0
  36. simoptlib-1.3.0.dev1/simopt/experiment/post_normalize_merit.py +175 -0
  37. simoptlib-1.3.0.dev1/simopt/experiment/post_replicate.py +207 -0
  38. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/experiment/run_solver.py +9 -48
  39. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/feasibility.py +1 -3
  40. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/input_models.py +45 -45
  41. simoptlib-1.3.0.dev1/simopt/logging.py +28 -0
  42. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/model.py +12 -20
  43. simoptlib-1.3.0.dev1/simopt/models/ambulance.py +132 -0
  44. simoptlib-1.3.0.dev1/simopt/models/amusementpark.py +183 -0
  45. simoptlib-1.3.0.dev1/simopt/models/chessmm.py +146 -0
  46. simoptlib-1.3.0.dev1/simopt/models/cntnv.py +144 -0
  47. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/models/contam.py +88 -248
  48. simoptlib-1.3.0.dev1/simopt/models/dualsourcing.py +148 -0
  49. simoptlib-1.3.0.dev1/simopt/models/dynamnews.py +140 -0
  50. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/models/ermexample.py +20 -81
  51. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/models/example.py +46 -105
  52. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/models/facilitysizing.py +51 -185
  53. simoptlib-1.3.0.dev1/simopt/models/fixedsan.py +174 -0
  54. simoptlib-1.3.0.dev1/simopt/models/hotel.py +124 -0
  55. simoptlib-1.3.0.dev1/simopt/models/ironore.py +249 -0
  56. simoptlib-1.3.0.dev1/simopt/models/mm1queue.py +158 -0
  57. simoptlib-1.3.0.dev1/simopt/models/network.py +137 -0
  58. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/models/paramesti.py +27 -98
  59. simoptlib-1.3.0.dev1/simopt/models/rmitd.py +151 -0
  60. simoptlib-1.3.0.dev1/simopt/models/san.py +534 -0
  61. simoptlib-1.3.0.dev1/simopt/models/sscont.py +192 -0
  62. simoptlib-1.3.0.dev1/simopt/models/tableallocation.py +166 -0
  63. simoptlib-1.3.0.dev1/simopt/options.py +39 -0
  64. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/plot_type.py +3 -2
  65. simoptlib-1.3.0.dev1/simopt/problem.py +345 -0
  66. simoptlib-1.3.0.dev1/simopt/simulations/__init__.py +1 -0
  67. simoptlib-1.3.0.dev1/simopt/simulations/ambulance.py +206 -0
  68. simoptlib-1.3.0.dev1/simopt/simulations/amusementpark.py +353 -0
  69. simoptlib-1.3.0.dev1/simopt/simulations/chessmm.py +158 -0
  70. simoptlib-1.3.0.dev1/simopt/simulations/cntnv.py +156 -0
  71. simoptlib-1.3.0.dev1/simopt/simulations/contam.py +158 -0
  72. simoptlib-1.3.0.dev1/simopt/simulations/dualsourcing.py +217 -0
  73. simoptlib-1.3.0.dev1/simopt/simulations/dynamnews.py +208 -0
  74. simoptlib-1.3.0.dev1/simopt/simulations/ermexample.py +61 -0
  75. simoptlib-1.3.0.dev1/simopt/simulations/example.py +69 -0
  76. simoptlib-1.3.0.dev1/simopt/simulations/facilitysizing.py +132 -0
  77. simoptlib-1.3.0.dev1/simopt/simulations/fixedsan.py +130 -0
  78. simoptlib-1.3.0.dev1/simopt/simulations/hotel.py +281 -0
  79. simoptlib-1.3.0.dev1/simopt/simulations/ironore.py +240 -0
  80. simoptlib-1.3.0.dev1/simopt/simulations/mm1queue.py +195 -0
  81. simoptlib-1.3.0.dev1/simopt/simulations/network.py +265 -0
  82. simoptlib-1.3.0.dev1/simopt/simulations/paramesti.py +80 -0
  83. simoptlib-1.3.0.dev1/simopt/simulations/rmitd.py +181 -0
  84. simoptlib-1.3.0.dev1/simopt/simulations/san.py +164 -0
  85. simoptlib-1.3.0.dev1/simopt/simulations/sscont.py +218 -0
  86. simoptlib-1.3.0.dev1/simopt/simulations/tableallocation.py +206 -0
  87. simoptlib-1.3.0.dev1/simopt/test.py +150 -0
  88. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/utils.py +179 -259
  89. simoptlib-1.3.0.dev1/simopt/web/__init__.py +1 -0
  90. simoptlib-1.3.0.dev1/simopt/web/dist/assets/index-BsdjTlAU.js +14 -0
  91. simoptlib-1.3.0.dev1/simopt/web/dist/assets/index-CdXZ_qpx.css +1 -0
  92. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/web/dist/index.html +2 -2
  93. simoptlib-1.3.0.dev1/simopt/web/plots.py +572 -0
  94. simoptlib-1.3.0.dev1/simopt/web/server.py +1811 -0
  95. simoptlib-1.3.0.dev1/simopt-dsl/src/simopt_dsl/__init__.py +8 -0
  96. simoptlib-1.3.0.dev1/simopt-dsl/src/simopt_dsl/expressions.py +273 -0
  97. simoptlib-1.3.0.dev1/simopt-dsl/src/simopt_dsl/model.py +723 -0
  98. simoptlib-1.3.0.dev1/simopt-dsl/src/simopt_dsl/py.typed +0 -0
  99. simoptlib-1.3.0.dev1/simopt-dsl/src/simopt_dsl/simulation.py +218 -0
  100. simoptlib-1.3.0.dev1/simopt-dsl/src/simopt_dsl/variables.py +77 -0
  101. simoptlib-1.3.0.dev1/simopt-dsl/tests/test_model.py +184 -0
  102. simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers/__init__.py +75 -0
  103. simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers/_utils.py +75 -0
  104. simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers/base.py +9 -0
  105. simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers/py.typed +0 -0
  106. simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers/solution.py +282 -0
  107. simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers/solver.py +315 -0
  108. simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers/solvers/__init__.py +1 -0
  109. {simoptlib-1.2.4/simopt → simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers}/solvers/_dasso.py +8 -5
  110. {simoptlib-1.2.4/simopt → simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers}/solvers/adam.py +34 -42
  111. {simoptlib-1.2.4/simopt → simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers}/solvers/aloe.py +47 -44
  112. {simoptlib-1.2.4/simopt → simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers}/solvers/astrodf.py +251 -272
  113. simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers/solvers/castrodf.py +2080 -0
  114. {simoptlib-1.2.4/simopt → simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers}/solvers/dasso.py +490 -528
  115. {simoptlib-1.2.4/simopt → simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers}/solvers/fcsa.py +47 -61
  116. {simoptlib-1.2.4/simopt → simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers}/solvers/neldmd.py +53 -132
  117. {simoptlib-1.2.4/simopt → simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers}/solvers/randomsearch.py +15 -21
  118. {simoptlib-1.2.4/simopt → simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers}/solvers/spsa.py +34 -48
  119. {simoptlib-1.2.4/simopt → simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers}/solvers/strong.py +77 -131
  120. {simoptlib-1.2.4/simopt → simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers}/solvers/utils.py +115 -53
  121. simoptlib-1.3.0.dev1/simopt-solvers/tests/test_solve.py +86 -0
  122. simoptlib-1.3.0.dev1/simopt-solvers/tests/test_specifications.py +55 -0
  123. simoptlib-1.3.0.dev1/simopt-web/node_modules/flatted/python/flatted.py +144 -0
  124. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simoptlib.egg-info/PKG-INFO +39 -120
  125. simoptlib-1.3.0.dev1/simoptlib.egg-info/SOURCES.txt +144 -0
  126. simoptlib-1.3.0.dev1/simoptlib.egg-info/entry_points.txt +2 -0
  127. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simoptlib.egg-info/requires.txt +6 -1
  128. simoptlib-1.3.0.dev1/simoptlib.egg-info/top_level.txt +3 -0
  129. {simoptlib-1.2.4/test → simoptlib-1.3.0.dev1/tests}/test_ambulance.py +19 -2
  130. simoptlib-1.3.0.dev1/tests/test_constrained_models.py +107 -0
  131. simoptlib-1.3.0.dev1/tests/test_experiments.py +233 -0
  132. simoptlib-1.3.0.dev1/tests/test_fd.py +70 -0
  133. simoptlib-1.3.0.dev1/tests/test_model_config.py +77 -0
  134. simoptlib-1.3.0.dev1/tests/test_notebooks.py +28 -0
  135. simoptlib-1.3.0.dev1/tests/test_planned_runner.py +269 -0
  136. simoptlib-1.2.4/README.md +0 -274
  137. simoptlib-1.2.4/simopt/GUI.py +0 -50
  138. simoptlib-1.2.4/simopt/__main__.py +0 -12
  139. simoptlib-1.2.4/simopt/base.py +0 -17
  140. simoptlib-1.2.4/simopt/bootstrap.py +0 -437
  141. simoptlib-1.2.4/simopt/curve.py +0 -231
  142. simoptlib-1.2.4/simopt/curve_utils.py +0 -242
  143. simoptlib-1.2.4/simopt/experiment/__init__.py +0 -7
  144. simoptlib-1.2.4/simopt/experiment/multiple.py +0 -815
  145. simoptlib-1.2.4/simopt/experiment/post_normalize.py +0 -294
  146. simoptlib-1.2.4/simopt/experiment/single.py +0 -878
  147. simoptlib-1.2.4/simopt/experimental.py +0 -109
  148. simoptlib-1.2.4/simopt/gui/data_farming_window.py +0 -1369
  149. simoptlib-1.2.4/simopt/gui/df_object.py +0 -703
  150. simoptlib-1.2.4/simopt/gui/main_menu.py +0 -111
  151. simoptlib-1.2.4/simopt/gui/new_experiment_window.py +0 -6479
  152. simoptlib-1.2.4/simopt/gui/plot_window.py +0 -1057
  153. simoptlib-1.2.4/simopt/gui/toplevel_custom.py +0 -106
  154. simoptlib-1.2.4/simopt/models/ambulance.py +0 -434
  155. simoptlib-1.2.4/simopt/models/amusementpark.py +0 -551
  156. simoptlib-1.2.4/simopt/models/chessmm.py +0 -279
  157. simoptlib-1.2.4/simopt/models/cntnv.py +0 -297
  158. simoptlib-1.2.4/simopt/models/dualsourcing.py +0 -355
  159. simoptlib-1.2.4/simopt/models/dynamnews.py +0 -337
  160. simoptlib-1.2.4/simopt/models/fixedsan.py +0 -294
  161. simoptlib-1.2.4/simopt/models/hotel.py +0 -411
  162. simoptlib-1.2.4/simopt/models/ironore.py +0 -484
  163. simoptlib-1.2.4/simopt/models/mm1queue.py +0 -321
  164. simoptlib-1.2.4/simopt/models/network.py +0 -418
  165. simoptlib-1.2.4/simopt/models/rmitd.py +0 -325
  166. simoptlib-1.2.4/simopt/models/san.py +0 -487
  167. simoptlib-1.2.4/simopt/models/sscont.py +0 -385
  168. simoptlib-1.2.4/simopt/models/tableallocation.py +0 -369
  169. simoptlib-1.2.4/simopt/plots/__init__.py +0 -21
  170. simoptlib-1.2.4/simopt/plots/area_scatterplot.py +0 -292
  171. simoptlib-1.2.4/simopt/plots/feasibility_progress.py +0 -301
  172. simoptlib-1.2.4/simopt/plots/progress_curve.py +0 -267
  173. simoptlib-1.2.4/simopt/plots/solvability_cdf.py +0 -208
  174. simoptlib-1.2.4/simopt/plots/solvability_profile.py +0 -578
  175. simoptlib-1.2.4/simopt/plots/terminal_feasibility.py +0 -478
  176. simoptlib-1.2.4/simopt/plots/terminal_progress.py +0 -175
  177. simoptlib-1.2.4/simopt/plots/terminal_scatterplot.py +0 -131
  178. simoptlib-1.2.4/simopt/plots/utils.py +0 -507
  179. simoptlib-1.2.4/simopt/problem.py +0 -704
  180. simoptlib-1.2.4/simopt/solver.py +0 -248
  181. simoptlib-1.2.4/simopt/solvers/__init__.py +0 -1
  182. simoptlib-1.2.4/simopt/web/dist/assets/index-BlZMNzom.js +0 -2
  183. simoptlib-1.2.4/simopt/web/dist/assets/index-DJP_mVbX.css +0 -1
  184. simoptlib-1.2.4/simoptlib.egg-info/SOURCES.txt +0 -93
  185. simoptlib-1.2.4/simoptlib.egg-info/top_level.txt +0 -3
  186. simoptlib-1.2.4/test/test_experiments.py +0 -44
  187. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/LICENSE +0 -0
  188. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/setup.cfg +0 -0
  189. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/__init__.py +0 -0
  190. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/data_farming/nolhs_design_table.npz +0 -0
  191. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/models/__init__.py +0 -0
  192. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/models/_ext.py +0 -0
  193. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/utils.pyi +0 -0
  194. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/web/dist/favicon.svg +0 -0
  195. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simopt/web/dist/icons.svg +0 -0
  196. {simoptlib-1.2.4/simopt → simoptlib-1.3.0.dev1/simopt-solvers/src/simopt_solvers}/problem_types.py +0 -0
  197. {simoptlib-1.2.4 → simoptlib-1.3.0.dev1}/simoptlib.egg-info/dependency_links.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: simoptlib
3
- Version: 1.2.4
3
+ Version: 1.3.0.dev1
4
4
  Summary: A testbed for simulation-optimization experiments.
5
5
  Author-email: David Eckman <eckman@tamu.edu>, Shane Henderson <sgh9@cornell.edu>, Sara Shashaani <sshasha2@ncsu.edu>, Cen Wang <cenwang@tamu.edu>
6
6
  License: MIT License
@@ -36,16 +36,21 @@ License-File: LICENSE
36
36
  Requires-Dist: boltons>=25.0.0
37
37
  Requires-Dist: colorama>=0.4.6
38
38
  Requires-Dist: cvxpy>=1.7.3
39
+ Requires-Dist: fastapi[standard]>=0.128.8
39
40
  Requires-Dist: joblib>=1.5.2
40
41
  Requires-Dist: matplotlib>=3.10.7
41
42
  Requires-Dist: mrg32k3a[rust]>=2.0.0
42
43
  Requires-Dist: numpy<2.4,>=2.3.4
43
44
  Requires-Dist: pandas>=2.3.3
45
+ Requires-Dist: pandera[pandas]>=0.27.0
44
46
  Requires-Dist: pillow>=12.0.0
45
- Requires-Dist: pydantic>=2.12.3
46
47
  Requires-Dist: pydoe>=0.9.7
48
+ Requires-Dist: pydantic>=2.12.3
47
49
  Requires-Dist: scipy>=1.16.3
48
50
  Requires-Dist: seaborn>=0.13.2
51
+ Requires-Dist: simpy>=4.1.2
52
+ Requires-Dist: structlog>=25.5.0
53
+ Requires-Dist: sympy>=1.14.0
49
54
  Provides-Extra: dev
50
55
  Requires-Dist: jupytext>=1.18.1; extra == "dev"
51
56
  Requires-Dist: pytest-xdist>=3.8.0; extra == "dev"
@@ -114,16 +119,17 @@ There are two ways to download a copy of the source code onto your machine:
114
119
 
115
120
  If you do not need the source code for SimOpt, you may install the library as a Python package instead. See the [Package](#package) and [Basic Example](#basic-example) sections for more details about this option.
116
121
 
117
- The `notebooks` folder includes several useful Jupyter notebooks and scripts that are easy to customize. You can either run the scripts as standalone programs or open the notebooks in JupyterLab or VS Code. A description of the contents is provided below:
122
+ The `notebooks` folder contains short, self-contained Jupyter notebooks (each runs in under a minute) that walk through the library. Each notebook is paired with a `.py` script via [Jupytext](https://jupytext.readthedocs.io/), so you can either run the scripts as standalone programs or open the notebooks in JupyterLab or VS Code. Older demo notebooks are kept in `archive/notebooks`.
118
123
 
119
- | File | Description |
120
- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
121
- | `demo_model.py` | Run multiple replications of a simulation model and report its responses |
122
- | `demo_problem.py` | Run multiple replications of a given solution for an SO problem and report its objective function values and left-hand sides of stochastic constraints |
123
- | `demo_problem_solver.py` | Run multiple macroreplications of a solver on a problem, save the outputs to a `.pickle` file in the `experiments/outputs` folder, and save plots of the results to `.png` files in the `experiments/plots` folder |
124
- | `demo_problems_solvers.py` | Run multiple macroreplications of groups of problem-solver pairs and save the outputs and plots |
125
- | `demo_data_farming_model.py` | Create a design over model factors, run multiple replications at each design point, and save the results to a comma separated value (`.csv`) file in the `data_farming_experiments` folder |
126
- | `demo_san-sscont-ironorecont_experiment` | Run multiple solvers on multiple versions of (s, S) inventory, iron ore, and stochastic activiy network problems and produce plots |
124
+ | Notebook | Description |
125
+ | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
126
+ | `01_model_and_problem` | Run replications of a simulation model, evaluate a problem at a solution, and estimate stochastic constraints |
127
+ | `02_single_experiment` | Run one solver on one problem, inspect the results, and plot progress curves, solvability CDFs, terminal progress, and area under the curve |
128
+ | `03_comparing_solvers` | Benchmark several solvers on a set of problem variants with solvability profiles, difference profiles, and terminal scatter plots |
129
+ | `04_constrained_problems` | Compare solver variants on a problem with stochastic constraints using feasibility progress and terminal feasibility plots |
130
+ | `05_data_farming` | Build designs over model, solver, and problem factors, run them, and load designs from a file |
131
+ | `06_extending_simopt` | Use data-driven input models, run discrete solvers, and supply a known optimal solution for normalization |
132
+ | `07_standalone_solvers` | Describe your own problem with `simopt_dsl`, run one solver on it with `simopt_solvers.solve`, and plot its recommendation history |
127
133
 
128
134
  ### Environment Setup
129
135
 
@@ -152,94 +158,12 @@ conda activate simopt
152
158
 
153
159
  If you wish to update the environment with the latest compatible packages, you can simply rerun the setup script.
154
160
 
155
- ## Graphical User Interface (GUI) - User Guide
156
-
157
- ### Main Menu
158
- To open the GUI, run `python -m simopt`. This will launch the main menu. From the menu, you will be given 2 options:
159
- 1. Open the `Data Farm Models` window
160
- 2. Open the `Simulation Optimization Experiments` window ([read more](#simulation-optimization-experiments))
161
-
162
- ### Simulation Optimization Experiments
163
-
164
- #### Overview
165
- From the GUI, you can create a specified **problem-solver pair** or a **problem-solver group**, run macroreplications, and generate plots. The main page provides ways to create or continue working with experiments:
166
-
167
- 1. Create an individual **problem-solver pair** with customized problem and solver factors.
168
- 2. Load a .pickle file of a previously created **problem-solver pair**.
169
- 3. Create a **problem-solver group**.
170
-
171
- At the bottom of the main page, there is a workspace containing all **problem-solver pair**s and **problem-solver group**s. The first tab lists the **problem-solver pair**s ready to be run or post-replicated, the second tab lists the **problem-solver group**s made from the cross-design or by generating a **problem-solver group** from partial set of **problem-solver pair** in the first tab, and the third tab lists those **problem-solver pair**s that are ready to be post-normalized and prepared for plotting.
172
-
173
- #### 1. Creating a **problem-solver pair**
174
- This is the main way to add **problem-solver pair**s to the queue in the workspace.
175
- 1. First, select a solver from the "Solver" dropdown list. Each of the solvers has an abbreviation for the type of problems the solver can handle. Once a solver is selected, the "Problem" list will be sorted and show only the problems that work with the selected solver.
176
- 2. Change factors associated with the solver as necessary. The first factor is a customizable name for the solver that use can specify.
177
- 3. All solvers with unique combinations of factors must have unique names, i.e., no two solvers can have the same name, but different factors. If you want to use the same solver twice for a problem but with different solver factors, make sure you change the name of the solver accordingly. For example, if you want to create two **problem-solver pair**s with the same problem and solver but with or without CRN for the solver, you can change the name of the solver of choice for each pair to reflect that. This name will appear in the queue within the workspace below.
178
- 4. Select a problem from the "Problem" dropdown list.
179
- Each problem has an abbreviation indicating which types of solver is compatible to solve it. The letters in the abbreviation stand for:
180
-
181
- | Objective | Constraint | Variable | Direct Gradient Observations |
182
- | ------------ | ----------------- | -------------- | ---------------------------- |
183
- | Single (S) | Unconstrained (U) | Discrete (D) | Available (G) |
184
- | Multiple (M) | Box (B) | Continuous (C) | Not Available (N) |
185
- | | Deterministic (D) | Mixed (M) | |
186
- | | Stochastic (S) | | |
187
-
188
- 6. Change factors associated with the problem and model as necessary.
189
- 7. All problems with unique factors must have unique names, i.e., no two problems can have the same name, but different factors. If you want to use the same problem twice for a solver but with different problem or model factors, make sure you change the name of the problem accordingly. This name will appear in the queue within the workspace below.
190
- 8. The number of macroreplications can be modified in the top-left corner. The default is 10.
191
- 9. Select the "Add **problem-solver pair**" button, which only appears when a solver and problem is selected. The **problem-solver pair** will be added in the "Queue of **problem-solver pair**s."
192
-
193
- #### 2. Loading a **problem-solver pair** from a file
194
- Instead of creating a **problem-solver pair** from scratch, you can load one from a \*.pickle file:
195
- 1. In the top left corner, click "Load a **problem-solver pair**". Your file system will pop up, and you can navigate to and select an appropriate \*.pickle file. The GUI will throw an error if the selected file is not a \*.pickle file.
196
- 2. Once a **problem-solver pair** object is loaded, it will be added to the "Queue of **problem-solver pair**s".
197
- 3. The Run and Post-Process buttons will be updated to accurately reflect whether the **problem-solver pair** has already been run and/or post-processed.
198
-
199
- #### 3. Creating a **problem-solver group**
200
- Currently, **problem-solver group**s can only be created within the GUI or command line; they cannot be loaded from a file.
201
-
202
- You can create a **problem-solver group** and add a new item to the "Queue of **problem-solver group**s" in two ways. The first is a quick grouping of problems and solvers that are compatible with their default factors:
203
- of problems and solvers with their default factors.
204
- 1. Click the "Create a **problem-solver group**" button.
205
- 2. Check the compatibility of the Problems and Solvers being selected. Note that solvers with deterministic constraint type can not handle problems with stochastic constraints (e.g., ASTRO-DF cannot be run on FACSIZE-2).
206
- 3. Specify the number of macroreplications - the default is 10.
207
- 4. Click "Confirm Cross-Design **problem-solver group**."
208
- 5. The pop-up window will disappear, and the **problem-solver pair**s frame will automatically switch to the "Queue of **problem-solver group**s".
209
- 6. To exit out of the **problem-solver group** pop-up without creating a **problem-solver group**, click the red "x" in the top-left corner of the window.
210
-
211
- The second is converting a list of **problem-solver pair**s into a **problem-solver group** by a cross-design:
212
- 1. Select the **problem-solver pair**s of interest from the "Queue of **problem-solver pair**s".
213
- 2. Clicking the "Convert to a **problem-solver group**" button. This will complete the cross-design for the partial list and create a new row in the "Queue of **problem-solver group**s".
214
-
215
- ### Running a **problem-solver pair** or a **problem-solver group**
216
- To run a **problem-solver pair** or a **problem-solver group**, click the "Run" button in the "Queue of **problem-solver pair**s" or "Queue of **problem-solver group**s". Once the **problem-solver pair** or **problem-solver group** has been run, the "Run" button becomes disabled.
217
- **Note:** Running a **problem-solver pair** can take anywhere from a couple of seconds to a couple of minutes depending on the **problem-solver pair** and the number of macroreplications.
218
-
219
- ### Post-Processing and Post-Normalization
220
- Post-processing happens before post-normalizing and after the run is complete. You can specify the number of post-replications and the (proxy) optimal solution or function value. After post-normalization is complete, the Plotting window appears.
221
- To exit out of the Post-Process/Normalize pop-up without post-processing or post-normalizing, click the red "x" in the top-left corner of the window.
222
-
223
- #### - **problem-solver pair**
224
- **problem-solver pair**s can be post-processed from the "Queue of **problem-solver pair**s" tab by clicking "Post-Process." Adjust Post-Processing factors as necessary. Only **problem-solver pair**s that have already been run can be post-processed. After post-processing, click the "Post-Normalize by Problem" tab to select which **problem-solver pair**s to post-normalize together.
225
- * Only **problem-solver pair**s with the same problem can be post-normalized together.
226
- * Once all **problem-solver pair**s of interest are selected, click the "Post-Normalize Selected" button at the bottom of the GUI (this button only appears when in the Post-Normalize tab).
227
- * In the new pop-up form, update any values necessary and click "Post-Normalize" when the **problem-solver pair**s are ready to be post-normalized.
228
-
229
- #### - **problem-solver group**
230
- **problem-solver group**s are post-processed and post-normalized at the same time. In the "Queue of **problem-solver group**s" tab, click the "Post-Process" button for the specific **problem-solver group**, then change any values necessary, then click "Post-Process".
231
-
232
- ### Plotting
233
- The Plotting page is identical for both **problem-solver pair**s and **problem-solver group**s. Currently, multiple **problem-solver pair**s with the same problem can be plotted together, and any problem-solver pair from a single **problem-solver group** can be plotted together:
234
- 1. On the left side, select one or more problems from the problem list.
235
- 2. Select solvers from the solver list.
236
- 3. On the right side, select a plot type and adjust plot parameters and settings.
237
- There are 5 settings common to most plot types: Confidence Intervals, Number of Bootstrap Samples, Confidence Level, Plot Together, and Print Max HW.
238
- The type of plots that are currently available in the GUI are: Mean Progress Curve, Quantile Progress Curve, Solve Time CDF, Scatter Plot, CDF Solvability, Quantile Solvability, CDF Difference Plot, Quantile Difference Plot, Terminal Box/Violin, and Terminal Scatter.
239
- 4. Click "Add."
240
- 5. All plots will show in the plotting queue, along with information about their parameters and where the file is saved.
241
- 6. To view one plot, click "View Plot." All plots can be viewed together by clicking "See All Plots" at the bottom of the page.
242
- 7. To return to the main page, click the red "x" in the top-left corner of the window.
161
+ ## Web Interface
162
+
163
+ To open the web interface, run `simopt web` (or `python -m simopt web`) and open http://localhost:8000.
164
+ From the web interface you can build and run problem-solver experiments, generate plots, and create data-farming designs for solvers, problems, and models.
165
+
166
+ The previous Tkinter GUI has been removed; it is preserved on the `archive/tkinter` branch.
243
167
 
244
168
  ## Package
245
169
  The `simoptlib` package is available to download through the Python Packaging Index (PyPI) and can be installed from the terminal with the following command:
@@ -251,38 +175,33 @@ python -m pip install simoptlib
251
175
  After installing `simoptlib`, the package's main modules can be imported from the Python console (or in code):
252
176
  ```
253
177
  import simopt
254
- from simopt import models, solvers, experiment_base
178
+ import simopt_solvers
179
+ from simopt import models
180
+ from simopt.experiment.api import SimulationConfig, run
181
+ from simopt.experiment.experiment import from_names
255
182
  ```
256
183
 
257
- The following snippet of code will run 10 macroreplications of the Random Search solver ("RNDSRCH") on the Continuous Newsvendor problem ("CNTNEWS-1"):
184
+ The following snippet of code will pair the Random Search solver ("RNDSRCH") with the Continuous Newsvendor problem ("CNTNEWS-1") and run 10 macroreplications:
258
185
  ```python
259
- myexperiment = simopt.experiment_base.ProblemSolver("RNDSRCH", "CNTNEWS-1")
260
- myexperiment.run(n_macroreps=10)
186
+ myexperiment = from_names("RNDSRCH", "CNTNEWS-1")
187
+ config = SimulationConfig(n_mreps=10, n_preps=200, n_preps_x0_xstar=200)
188
+ (analysis_input,) = run([myexperiment], config)
261
189
  ```
262
190
 
263
- The results will be saved to a .pickle file in a folder called `experiments/outputs`. To post-process the results, by taking, for example 200 postreplications at each recommended solution, run the following:
264
- ```python
265
- myexperiment.post_replicate(n_postreps=200)
266
- simopt.experiment_base.post_normalize([myexperiment], n_postreps_init_opt=200)
267
- ```
268
-
269
- A .txt file summarizing the progress of the solver on each macroreplication can be produced:
270
- ```python
271
- myexperiment.log_experiment_results()
272
- ```
273
-
274
- A .txt file called `RNDSRCH_on_CNTNEWS-1_experiment_results.txt` will be saved in a folder called `experiments/logs`.
191
+ Here `run` also post-processes the results, by taking 200 postreplications at each recommended solution and 200 replications to estimate the initial and optimal objective values. It returns one `AnalysisInput` per experiment, in the same order.
275
192
 
276
193
  One can then plot the mean progress curve of the solver (with confidence intervals) with the objective function values shown on the y-axis:
277
194
  ```python
278
- simopt.experiment_base.plot_progress_curves(
279
- experiments=[myexperiment],
280
- plot_type=simopt.experiment_base.PlotType.MEAN,
281
- normalize=False,
195
+ from simopt.analysis.progress_curve import ProgressCurve
196
+ from simopt.experiment.plot import save_plots
197
+
198
+ plot_files = save_plots(
199
+ [(myexperiment, analysis_input)],
200
+ ProgressCurve(agg="mean", normalize=False),
282
201
  )
283
202
  ```
284
203
 
285
- The Python scripts in the `notebooks` folder provide more guidance on how to run common experiments using the library.
204
+ The Python scripts in the `archive/notebooks` folder provide more guidance on how to run common experiments using the library.
286
205
 
287
206
  One can also use the SimOpt graphical user interface by running the following from the terminal:
288
207
  ```bash
@@ -0,0 +1,188 @@
1
+ ![SimOpt Logo](https://raw.githubusercontent.com/simopt-admin/simopt/master/.github/resources/logo_full_magnifying_glass.png)
2
+
3
+ ## About the Project
4
+ SimOpt is a testbed of simulation-optimization problems and solvers. Its purpose is to encourage the development and constructive comparison of simulation-optimization (SO) solvers (algorithms). We are particularly interested in the finite-time performance of solvers, rather than the asymptotic results that one often finds in related literature.
5
+
6
+ For the purposes of this project, we define simulation as a very general technique for estimating statistical measures of complex systems. A system is modeled as if the probability distributions of the underlying random variables were known. Realizations of these random variables are then drawn randomly from these distributions. Each replication gives one observation of the system response, i.e., an evaluation of the objective function or stochastic constraints. By simulating a system in this fashion for multiple replications and aggregating the responses, one can compute statistics and use them for evaluation and design.
7
+
8
+ Several papers have discussed the development of SimOpt and experiments run on the testbed:
9
+ * [Eckman et al. (2024)](https://ieeexplore.ieee.org/document/10408734) studies feasibility metrics for stochastically constrained simulation-optimization problems in preparation for introducing related metrics in SimOpt.
10
+ * [Shashaani et al. (2024)](https://dl.acm.org/doi/10.1145/3680282) conducts a large data-farming experiment over solver factors to learn relationships between their settings and a solver's finite-time performance.
11
+ * [Eckman et al. (2023)](https://pubsonline.informs.org/doi/10.1287/ijoc.2023.1273) is the most up-to-date publication about SimOpt and describes the code architecture and how users can interact with the library.
12
+ * [Eckman et al. (2023)](https://pubsonline.informs.org/doi/10.1287/ijoc.2022.1261) introduces the design of experiments for comparing solvers; this design has been implemented in the latest Python version of SimOpt. For detailed description of the terminology used in the library, e.g., factors, macroreplications, post-processing, solvability plots, etc., see this paper.
13
+ * [Eckman et al. (2019)](https://www.informs-sim.org/wsc19papers/374.pdf) describes in detail changes to the architecture of the MATLAB version of SimOpt and the control of random number streams.
14
+ * [Dong et al. (2017)](https://www.informs-sim.org/wsc17papers/includes/files/179.pdf) conducts an experimental comparison of several solvers in SimOpt and analyzes their relative performance.
15
+ * [Pasupathy and Henderson (2011)](https://www.informs-sim.org/wsc11papers/363.pdf) describes an earlier interface for MATLAB implementations of problems and solvers.
16
+ * [Pasupathy and Henderson (2006)](https://www.informs-sim.org/wsc06papers/028.pdf) explains the original motivation for the testbed.
17
+
18
+ ## Code
19
+ ### Python
20
+ - The [`master branch`](https://github.com/simopt-admin/simopt/tree/master) contains the source code for the latest stable release of the testbed
21
+ - The [`development branch`](https://github.com/simopt-admin/simopt/tree/development) contains the latest code for the testbed, but may contain more bugs than the master branch
22
+
23
+ ### Matlab
24
+ > ⚠️ MATLAB versions of this testbed are no longer supported
25
+ - The [`matlab branch`](https://github.com/simopt-admin/simopt/tree/matlab) contains a previous stable version of the testbed written in MATLAB
26
+
27
+ ## Documentation
28
+ Full documentation for the source code can be found on our **[readthedocs page](https://simopt.readthedocs.io/en/latest/index.html)**.
29
+
30
+ [![Documentation Status](https://readthedocs.org/projects/simopt/badge/?version=latest)](https://simopt.readthedocs.io/en/latest/?badge=latest)
31
+
32
+ ## Getting Started
33
+ ### Requirements
34
+ - [Miniconda or Anaconda](https://www.anaconda.com/download)
35
+ - If you already have a compatible IDE (such as VS Code), we've found that Miniconda will work fine at 1/10 of the size of Anaconda. Otherwise, you may need the Spyder IDE that comes with the full Anaconda distribution.
36
+ - It is ***highly recommended*** to check the box during installation to add Python/Miniconda/Anaconda to your system PATH.
37
+ - If you know you have Python installed but are getting a `Command not found` error when trying to use Python commands, then you may need to [add Python to your PATH](https://realpython.com/add-python-to-path/).
38
+ - [VS Code](https://code.visualstudio.com/download) (optional)
39
+ - This is a lightweight IDE that is compatible with Miniconda.
40
+ - [Git](https://git-scm.com/downloads) (optional)
41
+ - If you don't have Git installed, you can download the code as a zip file instead
42
+
43
+ ### Downloading Source Code
44
+ There are two ways to download a copy of the source code onto your machine:
45
+ 1. Download the code in a zip file by clicking the green `<> Code` button above repo contents and clicking the `Download ZIP` option, then unzip the code to a folder on your computer. This does not require `git` to be installed but makes downloading updates to the repository more challenging.
46
+ ![image](https://github.com/user-attachments/assets/3c45804c-f8b0-48ed-b32c-a443550c6ef5)
47
+
48
+ 1. [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) the branch you'd like to download to a folder on your computer. This requires `git` to be installed but makes downloading updates to the repository much easier.
49
+
50
+ If you do not need the source code for SimOpt, you may install the library as a Python package instead. See the [Package](#package) and [Basic Example](#basic-example) sections for more details about this option.
51
+
52
+ The `notebooks` folder contains short, self-contained Jupyter notebooks (each runs in under a minute) that walk through the library. Each notebook is paired with a `.py` script via [Jupytext](https://jupytext.readthedocs.io/), so you can either run the scripts as standalone programs or open the notebooks in JupyterLab or VS Code. Older demo notebooks are kept in `archive/notebooks`.
53
+
54
+ | Notebook | Description |
55
+ | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
56
+ | `01_model_and_problem` | Run replications of a simulation model, evaluate a problem at a solution, and estimate stochastic constraints |
57
+ | `02_single_experiment` | Run one solver on one problem, inspect the results, and plot progress curves, solvability CDFs, terminal progress, and area under the curve |
58
+ | `03_comparing_solvers` | Benchmark several solvers on a set of problem variants with solvability profiles, difference profiles, and terminal scatter plots |
59
+ | `04_constrained_problems` | Compare solver variants on a problem with stochastic constraints using feasibility progress and terminal feasibility plots |
60
+ | `05_data_farming` | Build designs over model, solver, and problem factors, run them, and load designs from a file |
61
+ | `06_extending_simopt` | Use data-driven input models, run discrete solvers, and supply a known optimal solution for normalization |
62
+ | `07_standalone_solvers` | Describe your own problem with `simopt_dsl`, run one solver on it with `simopt_solvers.solve`, and plot its recommendation history |
63
+
64
+ ### Environment Setup
65
+
66
+ After downloading the source code, you will need to configure the conda environment to run the code. This can be done by running the following command in the terminal:
67
+
68
+ #### Windows (Command Prompt)
69
+ ```cmd
70
+ setup_simopt.bat
71
+ ```
72
+
73
+ #### Windows (PowerShell)
74
+ ```powershell
75
+ cmd /c setup_simopt.bat
76
+ ```
77
+
78
+ #### MacOS/Linux
79
+ ```bash
80
+ chmod +x setup_simopt.sh && ./setup_simopt.sh
81
+ ```
82
+
83
+ This script will create a new conda environment called `simopt` and install all necessary packages. To activate the environment, run the following command in the terminal:
84
+
85
+ ```bash
86
+ conda activate simopt
87
+ ```
88
+
89
+ If you wish to update the environment with the latest compatible packages, you can simply rerun the setup script.
90
+
91
+ ## Web Interface
92
+
93
+ To open the web interface, run `simopt web` (or `python -m simopt web`) and open http://localhost:8000.
94
+ From the web interface you can build and run problem-solver experiments, generate plots, and create data-farming designs for solvers, problems, and models.
95
+
96
+ The previous Tkinter GUI has been removed; it is preserved on the `archive/tkinter` branch.
97
+
98
+ ## Package
99
+ The `simoptlib` package is available to download through the Python Packaging Index (PyPI) and can be installed from the terminal with the following command:
100
+ ```
101
+ python -m pip install simoptlib
102
+ ```
103
+
104
+ ## Basic Example
105
+ After installing `simoptlib`, the package's main modules can be imported from the Python console (or in code):
106
+ ```
107
+ import simopt
108
+ import simopt_solvers
109
+ from simopt import models
110
+ from simopt.experiment.api import SimulationConfig, run
111
+ from simopt.experiment.experiment import from_names
112
+ ```
113
+
114
+ The following snippet of code will pair the Random Search solver ("RNDSRCH") with the Continuous Newsvendor problem ("CNTNEWS-1") and run 10 macroreplications:
115
+ ```python
116
+ myexperiment = from_names("RNDSRCH", "CNTNEWS-1")
117
+ config = SimulationConfig(n_mreps=10, n_preps=200, n_preps_x0_xstar=200)
118
+ (analysis_input,) = run([myexperiment], config)
119
+ ```
120
+
121
+ Here `run` also post-processes the results, by taking 200 postreplications at each recommended solution and 200 replications to estimate the initial and optimal objective values. It returns one `AnalysisInput` per experiment, in the same order.
122
+
123
+ One can then plot the mean progress curve of the solver (with confidence intervals) with the objective function values shown on the y-axis:
124
+ ```python
125
+ from simopt.analysis.progress_curve import ProgressCurve
126
+ from simopt.experiment.plot import save_plots
127
+
128
+ plot_files = save_plots(
129
+ [(myexperiment, analysis_input)],
130
+ ProgressCurve(agg="mean", normalize=False),
131
+ )
132
+ ```
133
+
134
+ The Python scripts in the `archive/notebooks` folder provide more guidance on how to run common experiments using the library.
135
+
136
+ One can also use the SimOpt graphical user interface by running the following from the terminal:
137
+ ```bash
138
+ python -m simopt
139
+ ```
140
+
141
+ ## Contributing
142
+ You can contribute problems and solvers to SimOpt (or fix other coding bugs) by [forking](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository and initiating [pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) in GitHub to request that your changes be integrated.
143
+
144
+
145
+ ## Authors
146
+ The core development team currently consists of
147
+ - [**David Eckman**](https://eckman.engr.tamu.edu) (Texas A&M University)
148
+ - [**Sara Shashaani**](https://shashaani.wordpress.ncsu.edu) (North Carolina State University)
149
+ - [**Shane Henderson**](https://people.orie.cornell.edu/shane/) (Cornell University)
150
+ - [**Cen Wang**](https://cenwangumass.github.io/) (Texas A&M University)
151
+ - [**Emily Liu**](https://github.com/eyl48) (Cornell University)
152
+
153
+ Previous maintainer:
154
+
155
+ - [**William Grochocinski**](https://github.com/Grochocinski) (North Carolina State University)
156
+
157
+ ## Citation
158
+ To cite this work, please use the `CITATION.cff` file or use the built-in citation generator:
159
+ ![GitHub's built-in citation generator](https://github.com/user-attachments/assets/b8b49544-eb74-469e-aa37-68c2c0c3708b)
160
+
161
+
162
+ ## Acknowledgments
163
+ An earlier website for SimOpt ([http://www.simopt.org](http://www.simopt.org)) was developed through work supported by the following grants:
164
+ - National Science Foundation
165
+ - [DMI-0400287](https://www.nsf.gov/awardsearch/showAward?AWD_ID=0400287)
166
+ - [CMMI-0800688](https://www.nsf.gov/awardsearch/showAward?AWD_ID=0800688)
167
+ - [CMMI-1200315](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1200315)
168
+
169
+ Recent work on the development of SimOpt has been supported by the following grants
170
+ - National Science Foundation
171
+ - [IIS-1247696](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1247696)
172
+ - [CMMI-1254298](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1254298)
173
+ - [CMMI-1536895](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1536895)
174
+ - [CMMI-1537394](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1537394)
175
+ - [DGE-1650441](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1650441)
176
+ - [DMS-1839346](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1839346) (TRIPODS+X)
177
+ - [CMMI-2206972](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2206972)
178
+ - [OAC-2410948](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2410948)
179
+ - [OAC-2410949](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2410949)
180
+ - [OAC-2410950](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2410950)
181
+ - Air Force Office of Scientific Research
182
+ - FA9550-12-1-0200
183
+ - FA9550-15-1-0038
184
+ - FA9550-16-1-0046
185
+ - Army Research Office
186
+ - W911NF-17-1-0094
187
+
188
+ *Any opinions, findings and conclusions or recommendations expressed in this material are those of the authors and do not necessarily reflect the views of the National Science Foundation (NSF).*
@@ -3,20 +3,31 @@ requires = ["setuptools>=61.0"]
3
3
  build-backend = "setuptools.build_meta"
4
4
 
5
5
  [tool.setuptools.packages.find]
6
- where = ["."]
7
- include = ["simopt*"]
6
+ where = [".", "simopt-dsl/src", "simopt-solvers/src"]
7
+ include = ["simopt", "simopt.*", "simopt_dsl", "simopt_dsl.*", "simopt_solvers", "simopt_solvers.*"]
8
8
  # Ignore the build directory so we don't circularly include built distributions.
9
9
  exclude = ["build*"]
10
10
 
11
11
  [tool.setuptools.package-data]
12
12
  "simopt.data_farming" = ["*.npz"]
13
+ "simopt.web" = ["dist/*", "dist/**/*"]
14
+ "simopt_dsl" = ["py.typed"]
15
+ "simopt_solvers" = ["py.typed"]
13
16
 
14
17
  [tool.uv.sources]
15
18
  simopt-extensions = { git = "https://github.com/cenwangumass/simopt-extensions", rev = "b40a9c8" }
19
+ simopt-dsl = { workspace = true }
20
+ simopt-solvers = { workspace = true }
21
+
22
+ [tool.uv.workspace]
23
+ members = [
24
+ "simopt-dsl",
25
+ "simopt-solvers",
26
+ ]
16
27
 
17
28
  [project]
18
29
  name = "simoptlib"
19
- version = "1.2.4"
30
+ version = "1.3.0.dev1"
20
31
  authors = [
21
32
  { name = "David Eckman", email = "eckman@tamu.edu" },
22
33
  { name = "Shane Henderson", email = "sgh9@cornell.edu" },
@@ -36,16 +47,21 @@ dependencies = [
36
47
  "boltons>=25.0.0",
37
48
  "colorama>=0.4.6",
38
49
  "cvxpy>=1.7.3",
50
+ "fastapi[standard]>=0.128.8",
39
51
  "joblib>=1.5.2",
40
52
  "matplotlib>=3.10.7",
41
53
  "mrg32k3a[rust]>=2.0.0",
42
54
  "numpy>=2.3.4,<2.4",
43
55
  "pandas>=2.3.3",
56
+ "pandera[pandas]>=0.27.0",
44
57
  "pillow>=12.0.0",
45
- "pydantic>=2.12.3",
46
58
  "pydoe>=0.9.7",
59
+ "pydantic>=2.12.3",
47
60
  "scipy>=1.16.3",
48
61
  "seaborn>=0.13.2",
62
+ "simpy>=4.1.2",
63
+ "structlog>=25.5.0",
64
+ "sympy>=1.14.0",
49
65
  ]
50
66
 
51
67
  [project.optional-dependencies]
@@ -63,6 +79,9 @@ ext = [
63
79
  "simopt-extensions",
64
80
  ]
65
81
 
82
+ [project.scripts]
83
+ simopt = "simopt.cli:main"
84
+
66
85
  [project.urls]
67
86
  "Homepage" = "https://github.com/simopt-admin/simopt"
68
87
  "Documentation" = "https://simopt.readthedocs.io/en/latest/"
@@ -0,0 +1,6 @@
1
+ """Main module for the simopt package."""
2
+
3
+ from simopt.cli import main
4
+
5
+ if __name__ == "__main__":
6
+ main()
@@ -0,0 +1,15 @@
1
+ """Identity markers for simulations and input models."""
2
+
3
+ from typing import TypeVar
4
+
5
+ T = TypeVar("T")
6
+
7
+
8
+ def simulation(function: T) -> T:
9
+ """Mark a simulation without changing its Python behavior."""
10
+ return function
11
+
12
+
13
+ def input_model(cls: type[T]) -> type[T]:
14
+ """Mark an input model without changing its Python behavior."""
15
+ return cls
@@ -0,0 +1 @@
1
+ """Analysis and plotting functions."""