simoptlib 1.2.3__tar.gz → 1.3.0.dev0__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.
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/PKG-INFO +40 -121
- simoptlib-1.3.0.dev0/README.md +188 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/pyproject.toml +19 -3
- simoptlib-1.3.0.dev0/simopt/__main__.py +6 -0
- simoptlib-1.3.0.dev0/simopt/_markers.py +15 -0
- simoptlib-1.3.0.dev0/simopt/analysis/__init__.py +1 -0
- simoptlib-1.3.0.dev0/simopt/analysis/auc.py +233 -0
- simoptlib-1.3.0.dev0/simopt/analysis/bootstrap.py +300 -0
- simoptlib-1.3.0.dev0/simopt/analysis/common.py +375 -0
- simoptlib-1.3.0.dev0/simopt/analysis/deterministic_feasibility_progress.py +190 -0
- simoptlib-1.3.0.dev0/simopt/analysis/deterministic_terminal_feasibility.py +258 -0
- simoptlib-1.3.0.dev0/simopt/analysis/diff.py +266 -0
- simoptlib-1.3.0.dev0/simopt/analysis/feasibility_progress.py +264 -0
- simoptlib-1.3.0.dev0/simopt/analysis/merit.py +118 -0
- simoptlib-1.3.0.dev0/simopt/analysis/progress_curve.py +229 -0
- simoptlib-1.3.0.dev0/simopt/analysis/solvability.py +157 -0
- simoptlib-1.3.0.dev0/simopt/analysis/solvability_cdf.py +193 -0
- simoptlib-1.3.0.dev0/simopt/analysis/solvability_profile.py +354 -0
- simoptlib-1.3.0.dev0/simopt/analysis/terminal_feasibility.py +333 -0
- simoptlib-1.3.0.dev0/simopt/analysis/terminal_progress.py +124 -0
- simoptlib-1.3.0.dev0/simopt/analysis/terminal_scatterplot.py +133 -0
- simoptlib-1.3.0.dev0/simopt/cli.py +59 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/data_farming/data_farming_core.py +1 -2
- simoptlib-1.2.3/simopt/experiment_base.py → simoptlib-1.3.0.dev0/simopt/data_farming/design.py +111 -174
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/data_farming/nolhs.py +1 -2
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/data_farming_base.py +13 -25
- simoptlib-1.3.0.dev0/simopt/deterministic_feasibility.py +37 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/directory.py +11 -21
- simoptlib-1.3.0.dev0/simopt/dsl.py +15 -0
- simoptlib-1.3.0.dev0/simopt/experiment/__init__.py +16 -0
- simoptlib-1.3.0.dev0/simopt/experiment/api.py +466 -0
- simoptlib-1.3.0.dev0/simopt/experiment/data.py +35 -0
- simoptlib-1.3.0.dev0/simopt/experiment/experiment.py +146 -0
- simoptlib-1.3.0.dev0/simopt/experiment/plot.py +278 -0
- simoptlib-1.3.0.dev0/simopt/experiment/post_normalize.py +268 -0
- simoptlib-1.3.0.dev0/simopt/experiment/post_normalize_merit.py +175 -0
- simoptlib-1.3.0.dev0/simopt/experiment/post_replicate.py +207 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/experiment/run_solver.py +9 -48
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/feasibility.py +1 -3
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/input_models.py +45 -45
- simoptlib-1.3.0.dev0/simopt/logging.py +28 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/model.py +12 -20
- simoptlib-1.3.0.dev0/simopt/models/ambulance.py +132 -0
- simoptlib-1.3.0.dev0/simopt/models/amusementpark.py +183 -0
- simoptlib-1.3.0.dev0/simopt/models/chessmm.py +146 -0
- simoptlib-1.3.0.dev0/simopt/models/cntnv.py +144 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/models/contam.py +88 -248
- simoptlib-1.3.0.dev0/simopt/models/dualsourcing.py +148 -0
- simoptlib-1.3.0.dev0/simopt/models/dynamnews.py +140 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/models/ermexample.py +20 -81
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/models/example.py +46 -105
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/models/facilitysizing.py +51 -185
- simoptlib-1.3.0.dev0/simopt/models/fixedsan.py +174 -0
- simoptlib-1.3.0.dev0/simopt/models/hotel.py +124 -0
- simoptlib-1.3.0.dev0/simopt/models/ironore.py +249 -0
- simoptlib-1.3.0.dev0/simopt/models/mm1queue.py +158 -0
- simoptlib-1.3.0.dev0/simopt/models/network.py +137 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/models/paramesti.py +27 -98
- simoptlib-1.3.0.dev0/simopt/models/rmitd.py +151 -0
- simoptlib-1.3.0.dev0/simopt/models/san.py +534 -0
- simoptlib-1.3.0.dev0/simopt/models/sscont.py +192 -0
- simoptlib-1.3.0.dev0/simopt/models/tableallocation.py +166 -0
- simoptlib-1.3.0.dev0/simopt/options.py +39 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/plot_type.py +3 -2
- simoptlib-1.3.0.dev0/simopt/problem.py +345 -0
- simoptlib-1.3.0.dev0/simopt/simulations/__init__.py +1 -0
- simoptlib-1.3.0.dev0/simopt/simulations/ambulance.py +206 -0
- simoptlib-1.3.0.dev0/simopt/simulations/amusementpark.py +353 -0
- simoptlib-1.3.0.dev0/simopt/simulations/chessmm.py +158 -0
- simoptlib-1.3.0.dev0/simopt/simulations/cntnv.py +156 -0
- simoptlib-1.3.0.dev0/simopt/simulations/contam.py +158 -0
- simoptlib-1.3.0.dev0/simopt/simulations/dualsourcing.py +217 -0
- simoptlib-1.3.0.dev0/simopt/simulations/dynamnews.py +208 -0
- simoptlib-1.3.0.dev0/simopt/simulations/ermexample.py +61 -0
- simoptlib-1.3.0.dev0/simopt/simulations/example.py +69 -0
- simoptlib-1.3.0.dev0/simopt/simulations/facilitysizing.py +132 -0
- simoptlib-1.3.0.dev0/simopt/simulations/fixedsan.py +130 -0
- simoptlib-1.3.0.dev0/simopt/simulations/hotel.py +281 -0
- simoptlib-1.3.0.dev0/simopt/simulations/ironore.py +240 -0
- simoptlib-1.3.0.dev0/simopt/simulations/mm1queue.py +195 -0
- simoptlib-1.3.0.dev0/simopt/simulations/network.py +265 -0
- simoptlib-1.3.0.dev0/simopt/simulations/paramesti.py +80 -0
- simoptlib-1.3.0.dev0/simopt/simulations/rmitd.py +181 -0
- simoptlib-1.3.0.dev0/simopt/simulations/san.py +164 -0
- simoptlib-1.3.0.dev0/simopt/simulations/sscont.py +218 -0
- simoptlib-1.3.0.dev0/simopt/simulations/tableallocation.py +206 -0
- simoptlib-1.3.0.dev0/simopt/test.py +150 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/utils.py +179 -259
- simoptlib-1.3.0.dev0/simopt/web/__init__.py +1 -0
- simoptlib-1.3.0.dev0/simopt/web/dist/assets/index-BsdjTlAU.js +14 -0
- simoptlib-1.3.0.dev0/simopt/web/dist/assets/index-CdXZ_qpx.css +1 -0
- simoptlib-1.3.0.dev0/simopt/web/dist/favicon.svg +1 -0
- simoptlib-1.3.0.dev0/simopt/web/dist/icons.svg +24 -0
- simoptlib-1.3.0.dev0/simopt/web/dist/index.html +14 -0
- simoptlib-1.3.0.dev0/simopt/web/plots.py +572 -0
- simoptlib-1.3.0.dev0/simopt/web/server.py +1811 -0
- simoptlib-1.3.0.dev0/simopt-dsl/src/simopt_dsl/__init__.py +8 -0
- simoptlib-1.3.0.dev0/simopt-dsl/src/simopt_dsl/expressions.py +273 -0
- simoptlib-1.3.0.dev0/simopt-dsl/src/simopt_dsl/model.py +723 -0
- simoptlib-1.3.0.dev0/simopt-dsl/src/simopt_dsl/py.typed +0 -0
- simoptlib-1.3.0.dev0/simopt-dsl/src/simopt_dsl/simulation.py +218 -0
- simoptlib-1.3.0.dev0/simopt-dsl/src/simopt_dsl/variables.py +77 -0
- simoptlib-1.3.0.dev0/simopt-dsl/tests/test_model.py +184 -0
- simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers/__init__.py +75 -0
- simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers/_utils.py +75 -0
- simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers/base.py +9 -0
- simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers/py.typed +0 -0
- simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers/solution.py +282 -0
- simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers/solver.py +315 -0
- simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers/solvers/__init__.py +1 -0
- {simoptlib-1.2.3/simopt → simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers}/solvers/_dasso.py +8 -5
- {simoptlib-1.2.3/simopt → simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers}/solvers/adam.py +34 -42
- {simoptlib-1.2.3/simopt → simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers}/solvers/aloe.py +47 -44
- {simoptlib-1.2.3/simopt → simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers}/solvers/astrodf.py +251 -272
- simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers/solvers/castrodf.py +2080 -0
- {simoptlib-1.2.3/simopt → simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers}/solvers/dasso.py +490 -528
- {simoptlib-1.2.3/simopt → simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers}/solvers/fcsa.py +47 -61
- {simoptlib-1.2.3/simopt → simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers}/solvers/neldmd.py +53 -132
- {simoptlib-1.2.3/simopt → simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers}/solvers/randomsearch.py +15 -21
- {simoptlib-1.2.3/simopt → simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers}/solvers/spsa.py +34 -48
- {simoptlib-1.2.3/simopt → simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers}/solvers/strong.py +77 -131
- {simoptlib-1.2.3/simopt → simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers}/solvers/utils.py +115 -53
- simoptlib-1.3.0.dev0/simopt-solvers/tests/test_solve.py +86 -0
- simoptlib-1.3.0.dev0/simopt-solvers/tests/test_specifications.py +55 -0
- simoptlib-1.3.0.dev0/simopt-web/node_modules/flatted/python/flatted.py +144 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simoptlib.egg-info/PKG-INFO +40 -121
- simoptlib-1.3.0.dev0/simoptlib.egg-info/SOURCES.txt +144 -0
- simoptlib-1.3.0.dev0/simoptlib.egg-info/entry_points.txt +2 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simoptlib.egg-info/requires.txt +6 -2
- simoptlib-1.3.0.dev0/simoptlib.egg-info/top_level.txt +4 -0
- simoptlib-1.3.0.dev0/tests/test_ambulance.py +85 -0
- simoptlib-1.3.0.dev0/tests/test_constrained_models.py +107 -0
- simoptlib-1.3.0.dev0/tests/test_experiments.py +233 -0
- simoptlib-1.3.0.dev0/tests/test_fd.py +70 -0
- simoptlib-1.3.0.dev0/tests/test_model_config.py +77 -0
- simoptlib-1.3.0.dev0/tests/test_notebooks.py +28 -0
- simoptlib-1.3.0.dev0/tests/test_planned_runner.py +269 -0
- simoptlib-1.2.3/README.md +0 -273
- simoptlib-1.2.3/simopt/GUI.py +0 -50
- simoptlib-1.2.3/simopt/__main__.py +0 -12
- simoptlib-1.2.3/simopt/base.py +0 -17
- simoptlib-1.2.3/simopt/bootstrap.py +0 -437
- simoptlib-1.2.3/simopt/curve.py +0 -231
- simoptlib-1.2.3/simopt/curve_utils.py +0 -242
- simoptlib-1.2.3/simopt/experiment/__init__.py +0 -7
- simoptlib-1.2.3/simopt/experiment/multiple.py +0 -815
- simoptlib-1.2.3/simopt/experiment/post_normalize.py +0 -294
- simoptlib-1.2.3/simopt/experiment/single.py +0 -878
- simoptlib-1.2.3/simopt/experimental.py +0 -109
- simoptlib-1.2.3/simopt/gui/data_farming_window.py +0 -1369
- simoptlib-1.2.3/simopt/gui/df_object.py +0 -703
- simoptlib-1.2.3/simopt/gui/main_menu.py +0 -111
- simoptlib-1.2.3/simopt/gui/new_experiment_window.py +0 -6479
- simoptlib-1.2.3/simopt/gui/plot_window.py +0 -1057
- simoptlib-1.2.3/simopt/gui/toplevel_custom.py +0 -106
- simoptlib-1.2.3/simopt/models/amusementpark.py +0 -551
- simoptlib-1.2.3/simopt/models/chessmm.py +0 -279
- simoptlib-1.2.3/simopt/models/cntnv.py +0 -297
- simoptlib-1.2.3/simopt/models/dualsourcing.py +0 -355
- simoptlib-1.2.3/simopt/models/dynamnews.py +0 -337
- simoptlib-1.2.3/simopt/models/fixedsan.py +0 -294
- simoptlib-1.2.3/simopt/models/hotel.py +0 -411
- simoptlib-1.2.3/simopt/models/ironore.py +0 -484
- simoptlib-1.2.3/simopt/models/mm1queue.py +0 -321
- simoptlib-1.2.3/simopt/models/network.py +0 -418
- simoptlib-1.2.3/simopt/models/rmitd.py +0 -325
- simoptlib-1.2.3/simopt/models/san.py +0 -487
- simoptlib-1.2.3/simopt/models/sscont.py +0 -385
- simoptlib-1.2.3/simopt/models/tableallocation.py +0 -369
- simoptlib-1.2.3/simopt/plots/__init__.py +0 -21
- simoptlib-1.2.3/simopt/plots/area_scatterplot.py +0 -292
- simoptlib-1.2.3/simopt/plots/feasibility_progress.py +0 -301
- simoptlib-1.2.3/simopt/plots/progress_curve.py +0 -267
- simoptlib-1.2.3/simopt/plots/solvability_cdf.py +0 -208
- simoptlib-1.2.3/simopt/plots/solvability_profile.py +0 -578
- simoptlib-1.2.3/simopt/plots/terminal_feasibility.py +0 -478
- simoptlib-1.2.3/simopt/plots/terminal_progress.py +0 -175
- simoptlib-1.2.3/simopt/plots/terminal_scatterplot.py +0 -131
- simoptlib-1.2.3/simopt/plots/utils.py +0 -507
- simoptlib-1.2.3/simopt/problem.py +0 -704
- simoptlib-1.2.3/simopt/solver.py +0 -248
- simoptlib-1.2.3/simopt/solvers/__init__.py +0 -1
- simoptlib-1.2.3/simoptlib.egg-info/SOURCES.txt +0 -86
- simoptlib-1.2.3/simoptlib.egg-info/top_level.txt +0 -2
- simoptlib-1.2.3/test/test_experiments.py +0 -44
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/LICENSE +0 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/setup.cfg +0 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/__init__.py +0 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/data_farming/nolhs_design_table.npz +0 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/models/__init__.py +0 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/models/_ext.py +0 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/simopt/utils.pyi +0 -0
- {simoptlib-1.2.3/simopt → simoptlib-1.3.0.dev0/simopt-solvers/src/simopt_solvers}/problem_types.py +0 -0
- {simoptlib-1.2.3 → simoptlib-1.3.0.dev0}/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.
|
|
3
|
+
Version: 1.3.0.dev0
|
|
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
|
|
@@ -35,17 +35,21 @@ Description-Content-Type: text/markdown
|
|
|
35
35
|
License-File: LICENSE
|
|
36
36
|
Requires-Dist: boltons>=25.0.0
|
|
37
37
|
Requires-Dist: colorama>=0.4.6
|
|
38
|
-
Requires-Dist:
|
|
38
|
+
Requires-Dist: fastapi[standard]>=0.128.8
|
|
39
39
|
Requires-Dist: joblib>=1.5.2
|
|
40
40
|
Requires-Dist: matplotlib>=3.10.7
|
|
41
41
|
Requires-Dist: mrg32k3a[rust]>=2.0.0
|
|
42
42
|
Requires-Dist: numpy<2.4,>=2.3.4
|
|
43
43
|
Requires-Dist: pandas>=2.3.3
|
|
44
|
+
Requires-Dist: pandera[pandas]>=0.27.0
|
|
44
45
|
Requires-Dist: pillow>=12.0.0
|
|
45
46
|
Requires-Dist: pydantic>=2.12.3
|
|
46
|
-
Requires-Dist: pydoe>=0.9.7
|
|
47
47
|
Requires-Dist: scipy>=1.16.3
|
|
48
48
|
Requires-Dist: seaborn>=0.13.2
|
|
49
|
+
Requires-Dist: simpy>=4.1.2
|
|
50
|
+
Requires-Dist: simopt-dsl>=0.1.0
|
|
51
|
+
Requires-Dist: simopt-solvers[all]>=0.1.0
|
|
52
|
+
Requires-Dist: structlog>=25.5.0
|
|
49
53
|
Provides-Extra: dev
|
|
50
54
|
Requires-Dist: jupytext>=1.18.1; extra == "dev"
|
|
51
55
|
Requires-Dist: pytest-xdist>=3.8.0; extra == "dev"
|
|
@@ -114,16 +118,17 @@ There are two ways to download a copy of the source code onto your machine:
|
|
|
114
118
|
|
|
115
119
|
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
120
|
|
|
117
|
-
The `notebooks` folder
|
|
121
|
+
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
122
|
|
|
119
|
-
|
|
|
120
|
-
|
|
|
121
|
-
| `
|
|
122
|
-
| `
|
|
123
|
-
| `
|
|
124
|
-
| `
|
|
125
|
-
| `
|
|
126
|
-
| `
|
|
123
|
+
| Notebook | Description |
|
|
124
|
+
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
125
|
+
| `01_model_and_problem` | Run replications of a simulation model, evaluate a problem at a solution, and estimate stochastic constraints |
|
|
126
|
+
| `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 |
|
|
127
|
+
| `03_comparing_solvers` | Benchmark several solvers on a set of problem variants with solvability profiles, difference profiles, and terminal scatter plots |
|
|
128
|
+
| `04_constrained_problems` | Compare solver variants on a problem with stochastic constraints using feasibility progress and terminal feasibility plots |
|
|
129
|
+
| `05_data_farming` | Build designs over model, solver, and problem factors, run them, and load designs from a file |
|
|
130
|
+
| `06_extending_simopt` | Use data-driven input models, run discrete solvers, and supply a known optimal solution for normalization |
|
|
131
|
+
| `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
132
|
|
|
128
133
|
### Environment Setup
|
|
129
134
|
|
|
@@ -152,94 +157,12 @@ conda activate simopt
|
|
|
152
157
|
|
|
153
158
|
If you wish to update the environment with the latest compatible packages, you can simply rerun the setup script.
|
|
154
159
|
|
|
155
|
-
##
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
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.
|
|
160
|
+
## Web Interface
|
|
161
|
+
|
|
162
|
+
To open the web interface, run `simopt web` (or `python -m simopt web`) and open http://localhost:8000.
|
|
163
|
+
From the web interface you can build and run problem-solver experiments, generate plots, and create data-farming designs for solvers, problems, and models.
|
|
164
|
+
|
|
165
|
+
The previous Tkinter GUI has been removed; it is preserved on the `archive/tkinter` branch.
|
|
243
166
|
|
|
244
167
|
## Package
|
|
245
168
|
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 +174,33 @@ python -m pip install simoptlib
|
|
|
251
174
|
After installing `simoptlib`, the package's main modules can be imported from the Python console (or in code):
|
|
252
175
|
```
|
|
253
176
|
import simopt
|
|
254
|
-
|
|
177
|
+
import simopt_solvers
|
|
178
|
+
from simopt import models
|
|
179
|
+
from simopt.experiment.api import SimulationConfig, run
|
|
180
|
+
from simopt.experiment.experiment import from_names
|
|
255
181
|
```
|
|
256
182
|
|
|
257
|
-
The following snippet of code will
|
|
183
|
+
The following snippet of code will pair the Random Search solver ("RNDSRCH") with the Continuous Newsvendor problem ("CNTNEWS-1") and run 10 macroreplications:
|
|
258
184
|
```python
|
|
259
|
-
myexperiment =
|
|
260
|
-
|
|
185
|
+
myexperiment = from_names("RNDSRCH", "CNTNEWS-1")
|
|
186
|
+
config = SimulationConfig(n_mreps=10, n_preps=200, n_preps_x0_xstar=200)
|
|
187
|
+
(analysis_input,) = run([myexperiment], config)
|
|
261
188
|
```
|
|
262
189
|
|
|
263
|
-
|
|
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`.
|
|
190
|
+
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
191
|
|
|
276
192
|
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
193
|
```python
|
|
278
|
-
simopt.
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
194
|
+
from simopt.analysis.progress_curve import ProgressCurve
|
|
195
|
+
from simopt.experiment.plot import save_plots
|
|
196
|
+
|
|
197
|
+
plot_files = save_plots(
|
|
198
|
+
[(myexperiment, analysis_input)],
|
|
199
|
+
ProgressCurve(agg="mean", normalize=False),
|
|
282
200
|
)
|
|
283
201
|
```
|
|
284
202
|
|
|
285
|
-
The Python scripts in the `notebooks` folder provide more guidance on how to run common experiments using the library.
|
|
203
|
+
The Python scripts in the `archive/notebooks` folder provide more guidance on how to run common experiments using the library.
|
|
286
204
|
|
|
287
205
|
One can also use the SimOpt graphical user interface by running the following from the terminal:
|
|
288
206
|
```bash
|
|
@@ -299,6 +217,7 @@ The core development team currently consists of
|
|
|
299
217
|
- [**Sara Shashaani**](https://shashaani.wordpress.ncsu.edu) (North Carolina State University)
|
|
300
218
|
- [**Shane Henderson**](https://people.orie.cornell.edu/shane/) (Cornell University)
|
|
301
219
|
- [**Cen Wang**](https://cenwangumass.github.io/) (Texas A&M University)
|
|
220
|
+
- [**Emily Liu**](https://github.com/eyl48) (Cornell University)
|
|
302
221
|
|
|
303
222
|
Previous maintainer:
|
|
304
223
|
|
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+

|
|
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
|
+
[](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
|
+

|
|
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
|
+

|
|
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).*
|
|
@@ -10,13 +10,22 @@ exclude = ["build*"]
|
|
|
10
10
|
|
|
11
11
|
[tool.setuptools.package-data]
|
|
12
12
|
"simopt.data_farming" = ["*.npz"]
|
|
13
|
+
"simopt.web" = ["dist/*", "dist/**/*"]
|
|
13
14
|
|
|
14
15
|
[tool.uv.sources]
|
|
15
16
|
simopt-extensions = { git = "https://github.com/cenwangumass/simopt-extensions", rev = "b40a9c8" }
|
|
17
|
+
simopt-dsl = { workspace = true }
|
|
18
|
+
simopt-solvers = { workspace = true }
|
|
19
|
+
|
|
20
|
+
[tool.uv.workspace]
|
|
21
|
+
members = [
|
|
22
|
+
"simopt-dsl",
|
|
23
|
+
"simopt-solvers",
|
|
24
|
+
]
|
|
16
25
|
|
|
17
26
|
[project]
|
|
18
27
|
name = "simoptlib"
|
|
19
|
-
version = "1.
|
|
28
|
+
version = "1.3.0.dev0"
|
|
20
29
|
authors = [
|
|
21
30
|
{ name = "David Eckman", email = "eckman@tamu.edu" },
|
|
22
31
|
{ name = "Shane Henderson", email = "sgh9@cornell.edu" },
|
|
@@ -35,17 +44,21 @@ classifiers = [
|
|
|
35
44
|
dependencies = [
|
|
36
45
|
"boltons>=25.0.0",
|
|
37
46
|
"colorama>=0.4.6",
|
|
38
|
-
"
|
|
47
|
+
"fastapi[standard]>=0.128.8",
|
|
39
48
|
"joblib>=1.5.2",
|
|
40
49
|
"matplotlib>=3.10.7",
|
|
41
50
|
"mrg32k3a[rust]>=2.0.0",
|
|
42
51
|
"numpy>=2.3.4,<2.4",
|
|
43
52
|
"pandas>=2.3.3",
|
|
53
|
+
"pandera[pandas]>=0.27.0",
|
|
44
54
|
"pillow>=12.0.0",
|
|
45
55
|
"pydantic>=2.12.3",
|
|
46
|
-
"pydoe>=0.9.7",
|
|
47
56
|
"scipy>=1.16.3",
|
|
48
57
|
"seaborn>=0.13.2",
|
|
58
|
+
"simpy>=4.1.2",
|
|
59
|
+
"simopt-dsl>=0.1.0",
|
|
60
|
+
"simopt-solvers[all]>=0.1.0",
|
|
61
|
+
"structlog>=25.5.0",
|
|
49
62
|
]
|
|
50
63
|
|
|
51
64
|
[project.optional-dependencies]
|
|
@@ -63,6 +76,9 @@ ext = [
|
|
|
63
76
|
"simopt-extensions",
|
|
64
77
|
]
|
|
65
78
|
|
|
79
|
+
[project.scripts]
|
|
80
|
+
simopt = "simopt.cli:main"
|
|
81
|
+
|
|
66
82
|
[project.urls]
|
|
67
83
|
"Homepage" = "https://github.com/simopt-admin/simopt"
|
|
68
84
|
"Documentation" = "https://simopt.readthedocs.io/en/latest/"
|
|
@@ -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."""
|