Skip to content

Commit e6df7b8

Browse files
committed
partially update running page
1 parent 9a698c2 commit e6df7b8

File tree

9 files changed

+32
-18
lines changed

9 files changed

+32
-18
lines changed

docs/assets/running/batch_run.png

18.8 KB
Loading

docs/assets/running/direct_run.png

17.8 KB
Loading
14 KB
Loading
12.7 KB
Loading
16.6 KB
Loading
1.53 MB
Loading
330 KB
Loading
-1.64 KB
Loading

docs/running.md

Lines changed: 32 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,41 +5,53 @@
55
We assume that you have already registered and logged in to the platform.
66
To run the simulation you need to have proper project loaded in the editor window.
77

8-
![Alt text](assets/running/image.png)
8+
![Simulation set up](assets/running/simulation_set_up.png)
99

10-
To run the simulation please select `Simulation` item in the left menu. You will be presented with list of already completed simulations:
10+
To run the simulation, click `RUN` in the title bar, or select Simulation page from the Navigation Bar on the left.
1111

12-
![Alt text](assets/running/image-1.png)
12+
## Simulations Page
1313

14-
The simulation can be started by clicking on `RUN NEW SIMULATION` button which will present couple of options.
14+
The Simulations Page consists of 3 main sections:
15+
16+
1. Simulations Archive, where all previously run simulations are presented in paginated view
17+
2. Run new simulation form which presents different ways to run the simulation currently loaded to Editor
18+
3. Last 5 simulations, which always displays the 5 most recent simulations
19+
20+
> [!NOTE] For convenience, the sidebar with sections 2. and 3. is pinned to Simulations, Input files, and Results pages.
21+
> You can run and see recent simulations from each of these pages.
22+
23+
![Simulations Page](assets/running/simulations_page.png)
24+
25+
## Running the simulation
1526

1627
You could choose where to run simulation:
1728

18-
- as *DIRECT RUN* in the dedicated cloud resources (currently limited to 15 cores machine in the C3 PLGRID Cloud)
29+
- as *DIRECT RUN* in the dedicated cloud resources (currently limited to 15 cores machine in the C3 PLGrid Cloud)
1930
- as *BATCH RUN* in the HPC resources (by submitting the job to the SLURM batch management system in Ares supercomputer)
2031

21-
The direct run may have much shorter time to start the simulation, but the parallelism is limited to 15 cores. The batch run may take longer to start the simulation, but the parallelism is limited only by the resources available in the HPC cluster.
22-
23-
![Alt text](assets/running/image-2.png)
32+
The direct run may have much shorter time to start the simulation, but the parallelism is limited to 15 cores.
33+
The batch run may take longer to start the simulation, but the parallelism is limited only by the resources available in the HPC cluster.
2434

2535
## Direct run
2636

27-
### Submission
28-
Lets start by submitting the simulation with 15 cores, selecting proper number of tasks and `DIRECT RUN` option. Press start to submit the simulation.
29-
30-
![Alt text](assets/running/image-7.png)
37+
Direct run is the default option. In the form, you can change the name (doesn't need to be the same as the project title),
38+
number of tasks, and overwrite the number of primary particles (the default is specified under SETTINGS in Editor page).
3139

32-
You will see a new entry in the list of simulations with status `PENDING`. The simulation will start automatically when the resources will be available.
40+
![Direct Run](assets/running/direct_run.png)
3341

34-
![Alt text](assets/running/image-3.png)
42+
When the parameters are set, click `START SIMULATION` to send it to the YAPTIDE server.
43+
After successful submission, the simulation is in PENDING state.
44+
The simulation will start automatically when the resources will be available, then it will change to RUNNING state,
45+
and you will be able to see the progress of the simulation by observing the progress bar.
3546

36-
Once the simulation is running, the status will change to `RUNNING` and you will be able to see the progress of the simulation by observing the progress bar of each task.
47+
![Pending state](assets/running/direct_run_pending.png)
48+
![Running state](assets/running/direct_run_running.png)
3749

38-
![Alt text](assets/running/image-4.png)
50+
The simulation is also present in the pinned "Last 5 simulations" section.
3951

40-
You can see that some of the tasks may be already completed (green), while others are running (dark).
52+
![Pinned to Last 5 simulations section](assets/running/direct_run_queue.png)
4153

42-
![Alt text](assets/running/image-5.png)
54+
When the simulation finishes, it will automatically navigate to Results page and display the results.
4355

4456
### Viewing results
4557

@@ -82,6 +94,8 @@ X projection reveals that with 10^4 primaries statitics is not enough:
8294

8395
## Batch run
8496

97+
![Batch Run](assets/running/batch_run.png)
98+
8599
When executing simulation with 10^4 primaries and 15 cores, the process completed in 37 seconds. To obtain better statistics we will try to run 10^6 primaries on 100 parallel tasks. This is not possible with direct run, so we will use batch run.
86100

87101
![Alt text](assets/running/image-20.png)

0 commit comments

Comments
 (0)