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

Experiment Page - Panels

In this wiki page we cover the panels of the Experiment Page: Description Panel, Workflow Panel, Samples Panel, Datasets Panel, Files Panel, and the Template Builder Panel. Because the details of the Workflow Panel are a little more complex, the description on this page is just a summary, while the details are covered on separate page. We are using the demo project to document these features.

Description Panel

When you create a new Experiment, you are automatically taken to its detail panel; otherwise, you can click on the navigation button "Experiment Description":

Experiment page landing view

Here you can set the details of the experiment: state, title, and description. You can also add one or more pieces of additional metadata: goal(s), collaborator(s), funding source(s), working paper(s), publication(s) and citation(s). And, in addition, you can annotate the experiment with Notes using the Note edit panel. All of the fields, except the experiment-state radio buttons are standard text-input forms. The experiment-data "buttons" (for example '+ ADD GOAL') will add the form for the indicated item, and you simple type the information. The backing data is updated as you type - there is no need to take any additional action (there is no "Enter" or "Submit" button, it is not needed).

The experiment state radio buttons, where it says: "Active", "Completed" and "On Hold", are used to set the state of the experiment. This setting determines in which list the experiment appears on the project's Project Summary Page.

Workflow Panel

Workflow Panel image

This panel supports the creation, review, editing, and manipulation of workflows: action or measurement process diagrams showing the transformation or measurement of sample during the experiment. The detail of setting up and using a workflow are covered in a separate page.

Samples Panel

Samples Panel image

This panel list all the samples associated with the experiment. You can click on any sample in the list to see the timeline of the processes that have affected the sample.

Datasets Panel

Datasets Panel image

This panel allows you to create a dataset for publication. A dataset is intended to embody the parts of the experiment and it's accompanying data and documentation that are of interest in the context of publication (or pre-publication) for public viewing. A published dataset is made part of the Materials Commons public data site.

A dataset is a collection of parts of the experiment, and it can include processes (see workflow, below), samples, and files. But it can be limit to only part of the experiment, allowing you to select the processes, samples, and files that are included. By default when you select a process for addition to the dataset all the files, samples, and other processes associated with the that (selected) process are also included. Individual process, files and samples can then be deleted from the dataset.

The process of creating a dataset is not current documented - please contact [email protected] for further help.

Files Panel

Files Panel image

This panel lists all the files associated with experiment. Click on any file's link in the table to see the details associated with the file. The file is also rendered in a thumbnail image if it is at all visualizable.

Template Builder Panel

Template Builder Panel image

The template builder is used to create, edit, clone, and otherwise manipulate your Custom Materials Commons Templates. The functioning of this panel is not current documented - please contact [email protected] for further help. We anticipate further documentation in a separate section of these help pages.