You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Welcome to 2024 Winter Simulation Conference SimOpt Workshop!
3
+
# Welcome to 2025 Winter Simulation Conference SimOpt Workshop!
4
4
5
-
The SimOpt Workshop is taking place in-person in Grand 2 on Sunday, December 15 from 9am-noon.
5
+
The SimOpt Workshop is taking place in-person in on Sunday, December 7 from 9am-noon.
6
6
7
7
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.
8
8
@@ -11,73 +11,81 @@ The most-up-to-date publication about this library is [Eckman et al. (2023)](htt
11
11
## Before Workshop
12
12
Before attending the workshop please follow the instructions below:
13
13
14
-
1. Install Python and required dependencies [as detailed in the README](https://github.com/simopt-admin/simopt/blob/master/README.md#getting-started).
14
+
1. Install [miniconda](https://www.anaconda.com/docs/getting-started/miniconda/install#quickstart-install-instructions) (make sure you follow every step on the page for your operating system and `conda init --all` is run). After installation, close and reopen your terminal.
15
15
16
-
2.Install Microsoft's [Visual Studio Code (VS Code) IDE](https://code.visualstudio.com).
16
+
2.Set up a new Python virtual environment: `conda create -n simopt python=3.13`. This creates a new environment named `simopt` with Python 3.13 installed.
17
17
18
-
3. Next, install the [Python extension for VS Code](https://marketplace.visualstudio.com/items?itemName=ms-python.python) from the Visual Studio Marketplace. This will automatically install the Pylance (intellisense) and Python Debugger extensions as well.
18
+
3. Activate the virtual environment and install Python packages:
19
+
```bash
20
+
conda activate simopt
21
+
pip install jupyterlab simoptlib
22
+
```
23
+
24
+
4. Install Microsoft's [Visual Studio Code (VS Code) IDE](https://code.visualstudio.com).
25
+
26
+
5. Install the [Python extension for VS Code](https://marketplace.visualstudio.com/items?itemName=ms-python.python) and [Jupyter extension](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter) from the Visual Studio Marketplace.
19
27
20
-
4. To work with Python in Jupyter Notebooks, you must activate an Anaconda environment in VS Code, or another Python environment in which you've installed the [Jupyter package](https://pypi.org/project/jupyter/). To select an environment, use the **Python: Select Interpreter** command from the Command Palette `(⇧⌘P)`.
28
+
6. On your local hard drive, create a folder named `simopt_folder` somewhere convenient and open this folder in VS Code (click "Yes, I trust the authors" if a dialog shows up).
21
29
22
-
5. On your local hard drive, create a folder named `simopt_workspace` somewhere convenient.
30
+
7. In VS Code, go to the File menu and select “Open Folder…” and open the folder you created. That folder will become your VSCode workspace.
23
31
24
-
6. In VS Code, go to the File menu and select “Open Folder…” and open the folder you created. That folder will become your VSCode workspace.
32
+
8. Test the python interpreter:
25
33
26
-
7. Test the python interpreter:
27
34
* In the Explorer panel of VSCode editor click on the New File icon, and type `hello.py`.
28
35
36
+
29
37
* In the new file in the next panel, type:
30
-
```python
38
+
```python
31
39
msg ="Hello World"
32
40
print(msg)
33
41
```
34
42
43
+
***Important!** Use the **Python: Select Interpreter** command from the Command Palette `(⇧⌘P)` to select the newly created `simopt` environment.
44
+
35
45
* Hit run (the triangular play button) at the top right corner of the file.
36
-
46
+
 You should see Hello World printed in the terminal.
47
+
48
+
9. Test Jupyter notebook in VS Code:
37
49
38
-
9. Test the jupyter interpreter:
39
50
* In the VS Code editor, click on the add new file icon, and type `hello.ipynb`.
40
-
* In the new notebook file, type:
51
+
52
+
* In the new notebook file, click `Add code cell` button and type:
41
53
```python
42
54
msg ="Hello World"
43
55
print(msg)
44
56
```
45
57
46
-
* Hit run icon on the left side of the block in the notebook.
47
-
48
-
* You may get a dialog box asking you to install the ipykernel for python notebooks. If so, then perform the following step (recall Step 5), but otherwise, go on to Step 10 below.
49
-
* From within VSCode, select the python interpreter on the top-right corner of the panel that looks like  and from the list of available interpreters in your local computer, select the one that says Conda on the right.
50
-
* Select a Python 3 interpreter by opening the Command Palette (Ctrl+Shift+P or Command+Shift+P), start typing the Python: Select Interpreter command to search, then select that command.
58
+
* Hit run icon on the left side of the block in the notebook.
59
+
 When a Select kernel dialog shows up, click `Python Environments` and then `simopt`. Click the run icon again, Hello World should be printed below the cell.
60
+
61
+
Congratulations! You have successfully set up the environment needed for the workshop.
51
62
52
63
(There will an opportunity to do these last two steps during the workshop, but you can also attempt them beforehand.)
53
64
54
-
10. Open a terminal inside VSCode by clicking on Terminal > New Terminal from the menu. Inside the terminal, type the following to create a virtual environment:
55
-
*`python -m venv venv`
56
-
*`venv\Scripts\activate` or on a Mac, `source venv/bin/activate`
65
+
10. Open a terminal inside VSCode by clicking on Terminal > New Terminal from the menu. Inside the terminal, type the following to run the GUI:
57
66
58
-
* Then run the following commands to install the simopt package and open the GUI:
59
-
*`python -m pip install simoptlib`
60
-
*`python -m simopt`
61
-
* This may take a few minutes on the first launch to build the necessary dependency caches before the GUI is displayed. Subsequent launches will not have this issue.
67
+
```bash
68
+
conda activate simopt
69
+
python -m simopt
70
+
```
62
71
63
-
* A pop-up window with the GUI should open. You can close it.
72
+
* A pop-up window with the GUI should open. You can close it.
64
73
65
74
11. In your browser, navigate to [https://github.com/simopt-admin/simopt](https://github.com/simopt-admin/simopt). Click on "Download ZIP" as shown.
66
75
67
76
68
77
69
-
Unzip the folder **simopt-master** and open it in VS Code using `File > Open Folder`.
70
-
71
-
Open the file `workshop/workshop.ipynb` in the VS Code editor and follow along.
78
+
Unzip the folder **simopt-master** and open it in VS Code using `File > Open Folder`. Click "Yes, I trust the authors" if a dialog shows up.
72
79
80
+
Open the file `workshop/workshop.ipynb` in the VS Code editor and follow along. You may need to select the `simopt` virtual environment as in Step 8.
0 commit comments