Help for Experiment Page - materials-commons/materialscommons.org GitHub Wiki

Experiments Page

The starting page for seeing the current list of experiments is the Project page:

The landing page for a Project

At the top of the experiments-list panel (on the right) is set of radio buttons that select which experiments are listed based on the Experiments activity state: 'active', 'completed', or 'on hold'. The activity state of an experiment is set in the experiment detail panel described elsewhere. In addition there are three buttons for actions on experiments: START NEW EXPERIMENT, MERGE EXPERIMENTS, DELETE EXPERIMENTS, and NEW EXPERIMENT USING ETL. The buttons to create a new experiment, to merge experiments, and to delete experiments, are described below; the button to create a new experiment using ETL is described in the help page on Creating experiments from ELT.

When you first create a new experiment you are brought to the experiment page at the Details Panel and at all other times you when you select an experiment by clicking on its name in the experiment files which will take you to that experiment's Workflow Panel, shown here:

The Workflow Panel

You can also select an experiment using a shortcut, popup, menu, that will appear by clicking on the word 'Experiments' in the left hand menu bar, and then clicking on the experiment name in the pop-up menu.

When an experiment is (thus) opened and displayed the left-side menu-bar shows the experiment-panel options by expanding under the experiment name (see the screenshot directly above). The details of the panels that are selected by these controls are covered in three sections: one covering the Workflow Panel, one covering the template builder, and one covering the other panels. The main panel that you will use for collecting experiment data and for creating experiment meta-data will be the Workflow Panel.

The control bar at the top of this page and the project-related commands and panel selection actions (on the left side) are discussed in detail on the Project Page.

A general comment about saving changes in the UI for this site: if you do not see a save or enter button, then the changes are saved automatically as you type. So, in general, type or click the checkbox or radio button and the changes are saved as indicated by the UI.

Details of the Experiments List panel

Aside from the experiment list there are the four experiment-related commands, as below.

Start New Experiment

To start a new experiment, click on the button: START NEW EXPERIMENT. This brings up the new experiment dialog.

New Experiments pop-up dialog

Fill in the name and description, and click SUBMIT (or, of course, CANCEL), and you will see the details panel for the new Experiment (with the name and description filled in). You can edit any of the attributes of the details of the new Experiment as described in the help on the Details Panel:

Details panel showing new experiment

Merge Experiments

Clicking on the MERGE EXPERIMENTS button alters the list of experiments with checkboxes to select the experiments that you would like to merge:

Details of Merge selection

Select the experiments that you want to merge and click MERGE SELECTED (or CANCEL MERGE). This brings up the merge dialog, where you put in a name and description of the new Merged Experiment, and click MERGE (or CANCLE):

Merge confirmation dialog

When the experiments are merged (may take a while, for larger experiments), a new experiment appears in the experiment list, which is a merging of a copy for the selected experiments. Note that the original experiments are not deleted, but retained. If you no longer want them, you will have to delete then:

Experiments list showing merge results

Delete Experiments

Clicking on the DELETE EXPERIMENTS button alters the list of experiments with checkboxes to select the experiments that you would like to delete:

Details of delete selection

A confirmation dialog appears. Note the description:

Delete confirmation dialog

Then click DELETE (or CANCEL). Shows the experiment list with the deleted experiments gone:

Delete results