Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions docs/docs/tutorial/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,21 +111,21 @@ To create a new experiment, click the "New Experiment" button below your email i

Upon first login, your dashboard will be empty.

![dashboard](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-dashboard-03_2026.png)
![dashboard](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-dashboard-05_2026.png)

To run a default experiment, click the "Run a Default Experiment" button on the right side of the screen.

![run_default](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-run_default-03_2026.png)
![run_default](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-run_default-05_2026.png)

You will see a modal where you can select "Add Nums (Python)." This will present an already configured experiment.

![select_default](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-select_default-03_2026.png)
![select_default](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-select_default-05_2026.png)

The experiment creation interface consists of multiple tabs:

### Information Tab

![information_tab](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-information_tab-03_2026.png)
![information_tab](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-information_tab-05_2026.png)

#### Name *(Required)*

Expand Down Expand Up @@ -165,7 +165,7 @@ Defines the format of the config file generated for each trial. There are two op

### Parameters Tab

![parameters_tab](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-parameters_tab-03_2026.png)
![parameters_tab](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-parameters_tab-05_2026.png)

There are five parameter types:

Expand Down Expand Up @@ -201,7 +201,7 @@ Similar to Integer but supports decimal values.

### User Defined Constants Tab

![user_defined_constants_tab](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-user_defined_constants_tab-03_2026.png)
![user_defined_constants_tab](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-user_defined_constants_tab-05_2026.png)

This tab allows defining a text block appended to every generated `.ini` or `.yaml` config file. You can use parameters from the "Parameters" tab inside curly brackets.

Expand All @@ -214,21 +214,21 @@ test_var = {test}

### Post Process Tab

![post_process_tab](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-post_process_tab-03_2026.png)
![post_process_tab](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-post_process_tab-05_2026.png)

This tab allows you to include a scatter plot in the downloadable Project Zip. This feature will be replaced by ChartJS functionality on the dashboard in future updates.

This tab also allows for an email to be sent to the email affiliated with the GLADOS account when the experiment is completed, stating the status of the experiment.

### Confirmation Tab

![confirmation_tab](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-confirmation_tab-03_2026.png)
![confirmation_tab](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-confirmation_tab-05_2026.png)

This tab allows you to review all hyperparameters and settings before running the experiment.

### Dispatch Tab

![dispatch_tab](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-dispatch_tab-03_2026.png)
![dispatch_tab](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-dispatch_tab-05_2026.png)

You can start an experiment from this tab by either:

Expand All @@ -241,7 +241,7 @@ If you copied an experiment, the file will be preselected.

After dispatching the experiment, it will take a little bit before starting.

![awaiting_start_exp](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-awaiting_start_exp-03_2026.png)
![awaiting_start_exp](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-awaiting_start_exp-05_2026.png)

Once the experiment starts, you can monitor progress in real time.

Expand All @@ -254,7 +254,7 @@ The dashboard will display:

Example below:

![in_progress_exp](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-in_progress_exp-03_2026.png)
![in_progress_exp](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-in_progress_exp-05_2026.png)

For longer experiments, you can click the "Open Live Log" button to see live log updates from the configurations files. It updates every 5 seconds. This can help you identify when an error occurred mid experiment run.

Expand All @@ -264,7 +264,7 @@ You can cancel an experiment at any time. However, small experiments may finish

Example of completed experiment:

![finished_exp](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-finished_exp-03_2026.png)
![finished_exp](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-finished_exp-05_2026.png)

After completion, you can download the `results.csv` file, which contains output data and configurations for each trial. If extra files were generated, logs were kept, or post-processing was applied, a zip file will also be available.

Expand All @@ -276,19 +276,19 @@ Experiments can also be shared with other users. Click "Share Experiment" to cop

By clicking on "Archive Experiment", you can hide the experiment from view. You can see archived experiments by clicking on the "Filter" button and toggling "Include Archived". You can unarchive experiments by first including archived experiments in the dashboard and then clicking on "Unarchive Experiment".

![filter_archive](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-filter_archive-03_2026.png)
![filter_archive](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-filter_archive-05_2026.png)

You can also filter experiments by tags by using the Experiment Tags dropdown.

![filter_tags](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-filter_tags-03_2026.png)
![filter_tags](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-filter_tags-05_2026.png)

If you don't have any further use for an experiment, feel free to delete it by clicking "Delete Experiment".

![select-exps](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-select_exps-03_2026.png)
![select-exps](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-select_exps-05_2026.png)

In order to select experiments, you need to turn on ‘Edit Mode’, which is off by default. You will find it below the 'Expand All' and 'Collapse All' buttons. Each experiment will have a radio button to the left of it that allows you to select it. This enables you to delete or archive as many selected experiments as you would like.

![collapse](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-collapse-03_2026.png)
![collapse](https://raw.githubusercontent.com/AutomatingSciencePipeline/Monorepo/refs/heads/main/docs/images/usage-collapse-05_2026.png)

By default, experiments will be open, and will all reopen on refresh of the page. In order to close all of your experiments, you can use the ‘Select All’ button under ‘Edit Mode’.

Expand Down
Binary file removed docs/images/usage-awaiting_start_exp-03_2026.png
Binary file not shown.
Binary file added docs/images/usage-awaiting_start_exp-05_2026.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/usage-collapse-03_2026.png
Binary file not shown.
Binary file added docs/images/usage-collapse-05_2026.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/usage-confirmation_tab-03_2026.png
Binary file not shown.
Binary file added docs/images/usage-confirmation_tab-05_2026.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/usage-dashboard-03_2026.png
Binary file not shown.
Binary file added docs/images/usage-dashboard-05_2026.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/usage-dispatch_tab-03_2026.png
Binary file not shown.
Binary file added docs/images/usage-dispatch_tab-05_2026.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/usage-filter_archive-03_2026.png
Binary file not shown.
Binary file added docs/images/usage-filter_archive-05_2026.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/usage-filter_tags-03_2026.png
Binary file not shown.
Binary file added docs/images/usage-filter_tags-05_2026.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/usage-finished_exp-03_2026.png
Binary file not shown.
Binary file added docs/images/usage-finished_exp-05_2026.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/usage-in_progress_exp-03_2026.png
Binary file not shown.
Binary file added docs/images/usage-in_progress_exp-05_2026.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/usage-information_tab-03_2026.png
Binary file not shown.
Binary file added docs/images/usage-information_tab-05_2026.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/usage-parameters_tab-03_2026.png
Binary file not shown.
Binary file added docs/images/usage-parameters_tab-05_2026.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/usage-post_process_tab-03_2026.png
Binary file not shown.
Binary file added docs/images/usage-post_process_tab-05_2026.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/usage-run_default-03_2026.png
Binary file not shown.
Binary file added docs/images/usage-run_default-05_2026.png
Binary file removed docs/images/usage-select_default-03_2026.png
Diff not rendered.
Binary file added docs/images/usage-select_default-05_2026.png
Binary file removed docs/images/usage-select_exps-03_2026.png
Diff not rendered.
Binary file added docs/images/usage-select_exps-05_2026.png
Diff not rendered.
Loading