QC Atlas User Guide
QC Atlas is a platform for sharing quantum software as part of the Quantum Application Lifecycle Management (QuAntiL) and the project PlanQK. It enables the collection of information about quantum algorithms, available implementations, and publications. Also the collection of information about available software platforms, cloud services, and their offered compute resources, such as quantum computers and simulators, are enabled.
General Information about UI-Components
The UI of the QC Atlas is built using List Views
and Object Views
.
List View
List Views
can be reached by using the Navigation Bar
on the left side of the UI.
Some List Views
like the Execution Environments
can contain more List Views
. Navigation Bar
items that contain more List Views
have a Arrow Symbol
and can be extended by a simple click.
Data Table
The List Views
contain Data-Tables
which are responsible for displaying all available objects of a certain type. For every different object type there is a separate List View
. The user can use the controls of the tables to filter, sort and browse existing objects of a certain type.
Note
- To filter the displayed objects, the user can use the
Search Field
to filter objects by their names, titles or other criteria. - To sort the displayed objects, the user can click on the header of a certain column. A
Arrow Symbol
will appear that will indicate how the data is currently sorted (ASC/DESC). - To browse the objects, the user can switch and configure the pages of the
Data Table
by using thePagination Controls
which are located at the footer of the table. The user can either change the amount of displayed elements per page or change pages.
Note that all of these functionalities are optional and may not be available in every List View
Info
The Data Table
can also contain more means to manipulate the data:
- A
Create Button
orReference/Link Button
may be at the top of theData Table
, allowing the users to add new elements to theList View
. - In the
Actions Column
of theData Table
more buttons may be located allowing the user toEdit
orDelete/Dereference
existing objects and remove them from theList View
. - The first column of the
Data Table
may contain check-boxes which allow the user to select one or more elements of the current page of theData Table
to perform specific actions on multiple elements. One example would the the ability toDelete
orDereference
multiple elements at once.
In some cases, the elements of a Data Table
are also click-able. Then, the Mouse Cursor
will change to a Pointer
. If some element is clicked, the user will be redirected to that element's Object View
.
Object View
As mentioned before, any Object View
can be opened by clicking on any element of a List View
. In the Header
of any Object View
, it's Name
is displayed, as well as it's optional Tags
.
In addition, the Header
may also contain information about any Revision
of an object.
All other information about the object is located in the Body
of the Object View
. The information is distributed across multiple Tabs
. The General Tab
usually contains the most basic information about the object. Other information is distributed across the other Tabs
, which can differ from Object View
to Object View
.
Info
The Object View
is not only used to display information about an object. It is also used to:
Update
all kinds of information of that objectReference
orDereference
other objects- And more...
Revisions
QC Atlas supports the use of revisions which are a sort of versions or snapshots of an object.
When an object is saved, a revision is created automatically. This allows to browse and access older object data.
When a revision is selected, the data is automatically loaded into the property fields of the General Tab
and can then be viewed or edited.
Saving these properties will result in creating a new revision, which will be the latest version of the object.
Currently, the creation of revisions is supported for algorithms as well as implementations and only includes basic properties available in the General Tab
.
Algorithm
Create Algorithm
To create an algorithm the user has to navigate to the Algorithm List View
by using the navigation sidebar.
This view displays all available algorithms in a table. Creating a new algorithm is done via the Plus Button
which is located above the table.
Clicking on the Plus Button
will open the following Creation Dialog
, where the user has to type in all required information for creating a new algorithm.
Note
Depending on the selected Computational Model
, a third input field might show up, allowing the user to define the Quantum Computation Model
.
After entering all required information, the user has to confirm the creation of the algorithm by clicking on the OK Button
.
If the creation of the algorithm was successful, the user will be redirected to the detailed Algorithm View
of the new algorithm.
Delete Algorithm
Info
To perform the deletion of an algorithm, the user has to be in the Algorithm List View
.
To remove a specific algorithm, the user has to simply click on the Delete Button
in the Actions Column
of the data table.
The user can also remove multiple algorithms at once by selecting them using the check-boxes of the data table. After the user has made his selection he can press the Master Delete Button
at the top of the data table.
Note
The delete button will only appear if at least one algorithm is selected.
To confirm the deletion of the selected algorithm(s), the user has to click on the YES Button
of the Confirmation Dialog
.
Note
Names of algorithms that will be deleted are displayed in the body of the dialog and should be checked before confirming the deletion.
Update Algorithm Information
Info
To update the information of an algorithm, the user has to be in the Algorithm View
which can be reached by clicking on a algorithm in the Algorithm List View
.
Updating basic information is done in the General Tab
of the Algorithm View
. To do that, the user has to simply use the Input fields
, Check-Boxes
or Selection Drop-Downs
to add new values or adjust existing ones.
If information is changed, a Save button
will be displayed next that specific input field. Also, a Master Save button
will appear at the right side of the screen. To save the changes of each input field individually, the user can click on the Save button
next to any updated input field. Alternatively the user can save all changes by clicking the Master Save button
.
Note
The user can also hit Enter
on the keyboard to save the changes of a single field in most cases. In some cases, it may be necessary to focus the Save button
by hitting TAB
on the keyboard and then confirming with Enter
.
Info
Required Compute Resource Properties, Problem Types and Application Areas are stored separately and therefor do not belong to the basic information of the algorithm. They are saved, deleted or updated instantly without the use of the mentioned Save buttons
.
Load Algorithm Revision
Info
To load a revision of an algorithm, the user has to be in the Algorithm View
which can be reached by clicking on an algorithm in the Algorithm List View
.
Please see the revision section for further details about revisions.
Loading a revision is done by clicking on the revision selection field in the Algorithm View
.
This will open a dropdown menu with all available revisions sorted by their date with the latest revision at the top.
By selecting an element from the dropdown menu, the data of a revision is loaded in the Algorithm View
and can be viewed and edited.
Create Compute Resource Properties
Info
To create a compute resource property for the algorithm, the user has to be in the Algorithm View
which can be reached by clicking on an algorithm in the Algorithm List View
.
Creating properties for a compute resource is done in the General Tab
of the Algorithm View
. To do that, the user has to simply click on the Plus button
of the dedicated Required Compute Resource Property Field
.
This will open a separate Creation Dialog
where the user will have to enter all important information about the property he wants to create.
Note
The Type Name field supports auto-completion functionality. While typing a type name, the system will suggest existing types with that name in a drop-down. On click of an existing type, all necessary fields will be filled automatically.
After all fields have been filled, the user can finally add the property by confirming the creation via the existing OK Button
.
Note
The Property Value needs to match the selected Data Type.
After the property has been successfully created, it will appear in the the dedicated Required Compute Resource Property Field
of the Algorithm View
.
Update Compute Resource Properties
Info
To update a compute resource property of the algorithm, the user has to be in the Algorithm View
which can be reached by clicking on an algorithm in the Algorithm List View
.
Updating properties of an algorithm is done in the General Tab
of the Algorithm View
. To do that, the user has to simply hover over an existing property in the dedicated Required Compute Resource Property Field
and then click on the Edit button
.
This will open a separate Update Dialog
where the information of the property can be adjusted.
Note
The Type Name field supports auto-completion functionality. While typing a type name, the system will suggest existing types with that name in a drop-down. On click of an existing type, all necessary fields will be filled automatically.
After all fields have been adjusted, the user can finally update the property by confirming the update via the existing OK Button
.
Note
The Property Value needs to match the selected Data Type.
Delete Compute Resource Properties
Info
To delete a compute resource property of an algorithm, the user has to be in the Algorithm View
which can be reached by clicking on a compute resource in the Algorithm List View
.
Deleting compute resource properties is done in the General Tab
of the Algorithm View
. To do that, the user has to simply hover over an existing property in the dedicated Required Compute Resource Property Field
and then click on the Delete button
.
Info
A successfully deleted property should disappear from the dedicated Required Compute Resource Property Field
.
Reference Application Areas
Info
To reference application areas in an algorithm, the user has to be in the General Tab
of the Algorithm View
, which can be reached by clicking on an algorithm in the Algorithm List View
.
Referencing problem types is done via the dedicated Application Areas
field.
To link a application area with the algorithm, the user has to use the input field to search for an application area by typing it's name. While typing, the system's auto-complete feature will display available application areas in a drop-down. To finally link a application area, the user has to click on one of the available areas from the drop-down.
Note
Alternatively, the user can use the arrow keys of the keyboard to select an application area and confirm by hitting Enter
.
After successfully referencing the application area, it will be displayed in the Application Areas
field.
Dereference Application Areas
Info
To remove an existing reference to an application area, the user has to be in the General Tab
of the Algorithm View
, which can be reached by clicking on an algorithm in the Algorithm List View
.
To dereference an application area, the user has to scroll to the Application Areas
field and simply click on the Delete button
of the application area he wants to remove from the algorithm.
Reference Problem Types
Info
To reference problem types in an algorithm, the user has to be in the General Tab
of the Algorithm View
, which can be reached by clicking on an algorithm in the Algorithm List View
.
Referencing problem types is done via the dedicated Problem Types
field.
To link a problem type to the algorithm, the user has to use the input field to search for a problem type by typing it's name. While typing, the system's auto-complete feature will display available problem types in a drop-down. To finally link a problem type, the user has to click on one of the problem types from the drop-down.
Note
Alternatively, the user can use the arrow buttons on the keyboard to select a problem type and confirm the link with the "Enter" button on the keyboard.
After the linking process has been successfully completed, the freshly linked problem type will be displayed beneath the input field.
Dereference Problem Types
Info
To remove an existing reference to a problem type, the user has to be in the General Tab
of the Algorithm View
, which can be reached by clicking on an algorithm in the Algorithm List View
.
To dereference a problem type, the user has to scroll to the Problem Types
field and simply click on the Delete button
of the problem type he wants to remove from the algorithm.
Reference other Algorithms
Info
To reference other algorithms, the user has to be in the Related Algorithms Tab
of the Algorithm View
, which can be reached by clicking on an algorithm in the Algorithm List View
.
To reference some other algorithm in the current one, the user has to click on the Plus button
in the Related Algorithms Tab
.
A dialog will open that contains multiple fields that need to be filled by the user to create a relation to some algorithm.
In the first step, the user has to describe the relation by entering a description of the relation.
Then, the other algorithm that should be referenced needs to be selected. For that he can use the input field to find available algorithms by name. The auto-complete of the system will filter available algorithms and display them in a drop-down. The user can pick an algorithm by clicking on it.
Note
Alternatively, the user can use the arrow buttons on the keyboard to select an algorithm and then confirm it by hitting Enter
.
At last, the type of the relation of the two algorithms needs to be selected. While typing in a relation type, the auto-complete of the system will filter existing relation types while giving the user to ability to create a new one. The user can select an existing relation type or create a new by just by clicking on it.
Note
Alternatively, the user can use the arrow buttons on the keyboard to select a relation type and then confirm it by hitting Enter
.
After all input data has been filled, the user can confirm the creation of a reference between the two algorithms by clicking on the OK Button
.
After the other algorithm was successfully referenced, it will appear in the Related Algorithms
tab of the Algorithm View
.
Update Algorithm Relation
Info
To update an existing algorithm relation, the user has to be in the Related Algorithms Tab
of the Algorithm View
, which can be reached by clicking on an algorithm in the Algorithm List View
.
Updating an algorithm relation is done by clicking on the "Edit" button of a related algorithm in the Related Algorithms
tab.
This will open a dialog where the user can adjust the information of the relation. Here, the user can change the description and the type of the relation, before confirming the changes by clicking the OK Button
.
Note
Same as with the Creation Dialog
, the Relation Type
field has auto-complete functionality. The system will filter existing relation types while giving the user the ability to create a new one. The user can select an existing relation type or create a new by just by clicking on it or by using the arrow keys on the keyboard in combination with the Enter
key.
Dereference other Algorithms
Info
To delete existing references to other algorithms, the user has to be in the Related Algorithms Tab
of the Algorithm View
, which can be reached by clicking on a compute resource in the Algorithm List View
.
To remove a reference, the user can to simply click on the Delete Button
of a related algorithm in the Actions Column
.
Alternatively, use the check-boxes to select multiple algorithms and then click on the Master Delete button
to unlink all of them at once.
Note
Master Delete button
will only appear if at least one related algorithm is selected.
If a Delete
button is pressed, a confirmation dialog will appear listing all related algorithms that will be unlinked. To confirm the deletion of the relations to all displayed algorithms, the user has to click on the YES Button
.
Reference Publications
Info
To reference publications in an algorithm, the user has to be in the Publications Tab
of the Algorithm View
, which can be reached by clicking on an algorithm in the Algorithm List View
.
To initiate the linking of a publication, the user has to click on the Plus Button
in the Publications Tab
.
This will open a new dialog containing a page-able table of available publications. This table can be searched or sorted using the given input fields and buttons.
To reference a publication simply click on the Link Button
in the Actions Column
.
Alternatively, use the check-boxes to select multiple publications and then click on the Master Link Button
to link all of them at once.
Note
Master Link button
will only appear if at least one publication is selected.
Info
Successfully referenced publications(s) will now be visible in the Publications Tab
of the Algorithm View
.
Dereference Publications
Info
To dereference publications, the user has to be in the Publications Tab
of the Algorithm View
, which can be reached by clicking on an algorithm in the Algorithm List View
.
To remove a reference from a publication, the user has to simply click on the Delete Button
of a publication in the Actions Column
.
Alternatively, use the check-boxes to select multiple publications and then click on the Master Delete Button
to unlink all of them at once.
Note
Master Delete Button
will only appear if at least one publication is selected.
Add Tags
Info
To add tags to an algorithm, the user has to be in the Algorithm View
, which can be reached by clicking on an algorithm in the Algorithm List View
.
In the Header
of the Algorithm View
, the user has to click on the Plus Button
which is used to add tags.
A Add Tag Dialog
will open which contains fields for Tag Category
and Tag Value
that need to be defined for creating a new tag.
The Tag Value Field
is equipped auto-complete functionalities. While typing, it will recommend existing values to the user. The user can then either pick one of the existing values by clicking on it. Alternatively, the user can ignore the recommendations and fill the input field with a new tag value.
Note
Alternatively, the user can use the arrow buttons on the keyboard to select an existing tag value and then confirm it by hitting Enter
.
The Tag Category Field
is equipped auto-complete functionalities. While typing, it will recommend existing categories to the user. The user can then either pick one of the existing categories by clicking on it. Alternatively, the user can ignore the recommendations and fill the input field with a new tag category.
Note
Alternatively, the user can use the arrow buttons on the keyboard to select an existing tag category and then confirm it by hitting Enter
.
To finally add a new tag to the algorithm, the user has to confirm his selection by clicking on the OK Button
.
If the tag was added successfully, it will appear in the Header
of the Algorithm View
.
Remove Tags
Info
To remove tags from an algorithm, the user has to be in the Algorithm View
, which can be reached by clicking on an algorithm in the Algorithm List View
.
Removing tags is done by clicking on their Delete Buttons
, which are located in the Header
of the Algorithm View
.
Reference Patterns
Info
To reference patterns in an algorithm, the user has to be in the Related Patterns Tab
of the Algorithm View
, which can be reached by clicking on an algorithm in the Algorithm List View
.
To initiate the linking of a pattern, the user has to click on the Plus Button
in the Related Patterns Tab
.
This will open a new dialog containing multiple steps that need to be performed.
In the first step, a pattern language needs to be selected by simply clicking on it. To filter specific pattern languages, the user can use the input field to filter them by their name.
Info
By clicking on the small button at the bottom of a specific pattern language, a new browser window will open and all patterns of the selected pattern language are presented in the Pattern Atlas.
After a specific pattern language has been selected, the user can move the the next step by either clicking on the Next Button
or by clicking on the second step.
In the second step, the user has to pick a pattern he wants to reference by clicking on it. Like in the first step, he can use the input field to filter the patterns by their names and he also can use the scrollbar to scroll through all patterns.
Info
By clicking on the small button at the bottom of a specific pattern, a new browser window will open and the selected pattern with its properties is presented in the Pattern Atlas.
After a specific pattern has been selected, the user can move to the next step by either clicking on the Next Button
or by clicking on the third step.
In the third step, the user has to describe the relation between the selected pattern and the algorithm. To do that, he has to specify a Relation Type
and add a Description
.
The input field for the relation type has auto-complete functionality. It will filter all existing relation types while still providing the user the option to create a new one. To confirm a relation type, the user has to simply click on it.
Note
Alternatively, the arrow keys of the keyboard can be used to navigate through all the options. Selecting a relation type can be done by hitting Enter
.
At last, the user has to add a description by using the existing input field. After that, the user can proceed to the last step by clicking on the Next Button
or by clicking directly on the step itself.
The last step is used for verifying all the important selections from the previous steps. To finally reference the pattern in the algorithm, the user can press the Confirm Button
.
After the pattern was successfully referenced, it will appear in the Related Patterns Tab
of the Algorithm View
.
Update Pattern Relation
Info
To update the relation to a pattern, the user has to be in the Related Patterns Tab
of the Algorithm View
, which can be reached by clicking on an algorithm in the Algorithm List View
.
Updating a pattern relation is done by clicking on it's Edit Button
.
This will open a dialog containing two steps that need to be performed to successfully update the relation.
In the first step, the user can adjust the Relation Type
and the Description
.
To adjust the Relation Type
, the user simply has to use the existing input field to change the current type. The auto-complete functionality of the system will filter all existing relation types while still providing the user the option to create a new one. To confirm a relation type, the user has to simply click on it.
Note
Alternatively, the arrow keys of the keyboard can be used to navigate through all the options. Selecting a relation type can be done by hitting Enter
.
To adjust the Description
, the user can use the existing input field. After that, the user can proceed to the second step by clicking on the Next Button
or by clicking directly on the step itself.
The second and last step is used for verifying all the important selections from the first step. To finally adjust the reference between the pattern and the algorithm, the user has to click on the Confirm Button
.
Dereference Patterns
Info
To remove a reference to a pattern, the user has to be in the Related Patterns Tab
of the Algorithm View
, which can be reached by clicking on an algorithm in the Algorithm List View
.
Dereferencing a pattern is done by clicking on it's Delete Button
.
Alternatively, the user can use the check-boxes of the first column of the table to select all pattern relation he wants to remove before clicking on the Master Delete Button
.
Note
Master Delete Button
will only appear if at least one related pattern is selected.
If a Delete Button
is pressed, a confirmation dialog will appear listing all pattern references that will be removed. To confirm their deletion, the user has to click on the YES Button
.
Latex Renderer
Description
The generic component src/app/components/generics/property-input/text-input.component.ts
contains a flag latexActive
, which is disabled by default.
On activation via input properties, text-input
components are extended with a toggle slider to enable or disable Latex rendering for the respective input field.
Usage
When activated, the respective text-input
field will provide a LaTeX
button to open an editor with two text areas and a preview section.
The Additional LaTeX packages
field takes all statements, which have to be declared before the \begin{document} instruction in Latex.
The LaTeX content
field takes every input which should be rendered within the document.
will send a render request to the latex-rendering service on port
8083
and display the result in the appropriate section.
will close the dialog and discard any modifications made.
will cache all modifications to the packages and content input fields and close the dialog.
Whenever the dialog closes with a modified text to render, the text-input
component requests a rendering and displays the response as a svg
snippet. The text-input
signals modified content with a displayed save
button.
Drawbacks
The Latex renderer service has been extended by OpenAPI's RESTful interface and has successfully been tested locally, but runs into a rendering error when executed in a docker container using the project's Dockerfile
.
Once the docker container works as intended, the latex-renderer
feature can be enabled and leveraged for text-input
components.
Implementation
Create Implementation
Info
To create an implementation, the user has to be in the Algorithm View
of a specific algorithm.
In the Algorithm View
the user has to click on the Implementation Tab
, which opens the Implementation List View
.
This view contains all implementations of that algorithm. Within this view, a new implementation will be created via the Plus Button
which is located above the list.
Clicking on the Plus Button
will open the following dialog.
In the dialog it is possible to give the new implementation a name.
Note
To create a new implementation only a name
is required.
After all necessary fields have been filled in, the creation of the implementation can be confirmed by clicking on the OK Button
. After a successful creation, the user will be navigated to the Implementation View
of the new implementation.
Delete Implementation
Info
To delete an implementation, the user has to be in the Implementation Tab
of the Algorithm View
of a specific algorithm.
To delete a specific implementation, the user has to simply click on the Delete Button
in the Action Column
of the data table.
It is also possible to delete multiple implementations at once by selecting them one by one using the check-boxes within the table. When at least one implementation is selected, a Master Delete Button
will show up above the table. To delete the selected implementations at once, this button must be pressed.
Both ways of deleting implementations will lead to a confirmation dialog. This dialog will list all implementations that were selected to be deleted. To finally confirm the deletion, the OK Button
at the bottom of the dialog has to be pressed. A successfully deleted implementation will disappear from the Implementation List View
.
Update Implementation Information
Info
To update the information of a implementation, the user has to be in the Implementation View
.
Updating basic information is done in the General Tab
of the Implementation View
. To do that, the user has to simply use the Input fields
, Check-Boxes
or Selection Drop-Downs
to add new values or adjust existing ones.
If information is changed, a Save Button
will be displayed next that specific input field. Also, a Master Save Button
will appear at the right side of the screen. To save the changes of each input field individually, the user can click on the Save Button
next to any updated input field. Alternatively the user can save all changes by clicking the Master Save Button
.
Note
The user can also hit Enter
on the keyboard to save the changes of a single field in most cases. In some cases, it may be necessary to focus the Save Button
by hitting TAB
on the keyboard and then confirming with Enter
.
Load Implementation Revision
Info
To load a revision of an implementation, the user has to be in the Implementation View
which can be reached by clicking on an implementation in the Implementation List View
.
Please see the revision section for further details about revisions.
Loading a revision is done by clicking on the revision selection field in the Implementation View
.
This will open a dropdown menu with all available revisions sorted by their date with the latest revision at the top.
By selecting an element from the dropdown menu, the data of a revision is loaded in the Implementation View
and can be viewed and edited.
Create Compute Resource Properties
Info
To create a compute resource property for the implementation, the user has to be in the Implementation View
which can be reached by clicking on an implementation in the Implementation List View
.
Creating properties for a compute resource is done in the General Tab
of the Implementation View
.
To do that, the user has to simply click on the Plus Button
of the dedicated Required Compute Resource Property Field
.
This will open a separate Creation Dialog
where the user will have to enter all important information of about the property he wants to create.
Note
The Type Name field supports auto-completion functionality. While typing a type name, the system will suggest existing types with that name in a drop-down. If the user clicks on an existing type, all necessary fields will be filled automatically.
After all fields have been filled, the user can finally add the property by confirming the creation via the existing OK Button
.
Note
The Property Value needs to match the selected Data Type.
After the property has been successfully created, it will appear in the the dedicated Required Compute Resource Property Field
within theGeneral Tab
.
Update Compute Resource Properties
Info
To update a compute resource property of an implementation, the user has to be in the Implementation View
, which can be reached by clicking on an algorithm in the Implementation List View
.
Updating existing compute resource properties of an implementation is done in the General Tab
of the Implementation View
. To do that, the user has to simply hover over an existing property in the dedicated Required Compute Resource Property Field
and then click on the Edit Button
.
This will open a separate Update Dialog
where the information of the property can be adjusted.
Note
The Type Name field supports auto-completion functionality. While typing a type name, the system will suggest existing types with that name in a drop-down. On click of an existing type, all necessary fields will be filled automatically.
After all fields have been adjusted, the user can finally update the property by confirming the update via the existing OK Button
.
Note
The Property Value needs to match the selected Data Type.
Delete Compute Resource Properties
Info
To delete a property for an implementation, the user has to be in the Implementation View
which can be reached by clicking on a compute resource in the Implementation List View
.
Deleting compute resource properties of an implementation is done in the General Tab
of the Implementation View
.
To do that, the user has to simply hover over a existing property in the dedicated Required Compute Resource Property Field
and then click on the Delete Button
.
Info
A successfully deleted property should disappear from the dedicated Required Compute Resource Property Field
.
Reference Publications
Info
To reference publications in an implementation, the user has to be in the Publications Tab
of the Implementation View
, which can be reached by clicking on an implementation in the Implementation List View
.
To initiate the linking of a publication, the user has to click on the Plus Button
in the Publications Tab
.
This will open a new dialog containing a page-able table of available publications. This table can be searched or sorted using the given input fields and buttons.
To reference a publication simply click on the Link Button
in the Actions Column
.
Alternatively, use the check-boxes to select multiple publications and then click on the Master Link Button
to link all of them at once.
Note
Master Link Button
will only appear if at least one publication is selected.
Info
Successfully referenced publications(s) will now be visible in the Publications Tab
of the Implementation View
.
Dereference Publications
Info
To dereference publications, the user has to be in the Publications Tab
of the Implementation View
, which can be reached by clicking on an implementation in the Implementation List View
.
To remove a reference to a publication, the user has to simply click on the Delete Button
of a publication in the Actions Column
.
Alternatively, use the check-boxes to select multiple publications and then click on the Master Delete Button
to unlink all of them at once.
Note
Master Delete Button
will only appear if at least one publication is selected.
Reference Software Platforms
Info
To reference software platforms in an implementation, the user has to be in the Software Platforms Tab
of the Implementation View
, which can be reached by clicking on an implementation in the Implementation List View
.
To initiate the linking of a software platform, the user has to click on the Plus Button
in the Software Platforms Tab
.
This will open a new dialog containing a page-able table of available software platforms. This table can be searched or sorted using the given input fields and buttons.
To reference a software platform simply click on the Link Button
in the Actions Column
.
Alternatively, use the check-boxes to select multiple software platforms and then click on the Master Link Button
to link all of them at once.
Note
Master Link Button
will only appear if at least one software platform is selected.
Info
Successfully referenced software platform(s) will now be visible in the Software Platforms Tab
of the Implementation View
.
Dereference Software Platforms
Info
To dereference software platforms, the user has to be in the Software Platforms Tab
of the Implementation View
, which can be reached by clicking on an implementation in the Implementation List View
.
To remove a reference from a software platform, the user has to simply click on the Delete Button
of a software platform in the Actions Column
.
Alternatively, use the check-boxes to select multiple software platforms and then click on the Master Delete Button
to unlink all of them at once.
Note
Master Delete Button
will only appear if at least one software platform is selected.
Add Tags
Info
To add tags to an implementation, the user has to be in the Implementation View
, which can be reached by clicking on an implementation in the Implementation List View
.
In the Header
of the Implementation View
, the user has to click on the Plus Button
which is used to add tags.
A Add Tag Dialog
will open that contains fields for Tag Category
and Tag Value
that need to be defined for creating a new tag.
The Tag Value Field
is equipped auto-complete functionalities. While typing, it will recommend existing values to the user. The user can then either pick one of the existing values by clicking on it. Alternatively, the user can ignore the recommendations and fill the input field with a new tag value.
Note
Alternatively, the user can use the arrow buttons on the keyboard to select an existing tag value and then confirm it by hitting Enter
.
The Tag Category Field
is equipped auto-complete functionalities. While typing, it will recommend existing categories to the user. The user can then either pick one of the existing categories by clicking on it. Alternatively, the user can ignore the recommendations and fill the input field with a new tag category.
Note
Alternatively, the user can use the arrow buttons on the keyboard to select an existing tag category and then confirm it by hitting Enter
.
To finally add a new tag to the implementation, the user has to confirm his selection by clicking on the OK Button
.
If the tag was added successfully, it will appear in the Header
of the Implementation View
.
Remove Tags
Info
To remove tags from an implementation, the user has to be in the Implementation View
, which can be reached by clicking on an implementation in the Implementation List View
.
Removing tags is done by clicking on their Delete Buttons
, which are located in the Header
of the Implementation View
.
Publication
Create Publication
To create a publication, the user has to navigate to the Publication List View
by using the navigation sidebar. This view contains a data table of all available publications. Creating a new publication is done via the Plus Button
which is located above the table.
Clicking on the Plus Button
will open the following dialog.
In the dialog, it is possible to give the new publication a title and assign multiple authors to it. A new author will be added by using the Add Author Button
on the right side. An existing author will be removed using the Delete Author Button
.
Note
To create a new publication a title
and at least one author
is required.
After all necessary fields have been filled in, the creation of the publication can be confirmed by clicking on the OK Button
. After a successful creation, the user will be navigated to the Publication View
of the new publication.
Delete Publication
Info
To perform the deletion of a publication, the user has to be in the Publication List View
.
To remove a specific publication, the user has to simply click on the Delete Button
in the Actions Column
of the data table.
The user can also remove multiple publications at once by selecting them using the check-boxes of the data table. After the user has made his selection he can press the Master Delete Button
at the top of the data table.
Note
The Master Delete Button
will only appear after at least one publication is selected.
To confirm the deletion of the selected publication(s), the user has to click on the YES Button
of the Confirmation Dialog
.
Note
Titles of publications that will be deleted are displayed in the body of the dialog and should be checked before confirming the deletion.
Update Publication Information
Info
To update the information of a publication, the user has to be in the Publication View
which can be reached by clicking on a publication in the Publication List View
.
Updating basic information is done in the General Tab
of the Publication View
. To do that, the user has to simply use the Input fields
, Check-Boxes
or Selection drop-downs
to add new values or adjust existing ones.
If information is changed, a Save Button
will be displayed next that specific input field. Also, a Master Save Button
will appear at the right side of the screen. To save the changes of each input field individually, the user can click on the Save Button
next to any updated input field. Alternatively the user can save all changes by clicking the Master Save Button
.
Note
The user can also hit Enter
on the keyboard to save the changes of a single field in most cases. In some cases, it may be necessary to focus the Save Button
by hitting TAB
on the keyboard and then confirming with Enter
.
Reference Algorithms
Info
To reference algorithms in an existing publication, the user has to be in the Publication View
.
In the Publication View
of the publication, the user as to switch to the Algorithms Tab
, which is dedicated to referencing algorithms.
To link algorithms with the currently selected publication, the user has to click on the Plus Button
at the top of the data table.
This will open a dialog with a separate data list of existing algorithms.
For referencing publications the user can now search the table and click on the Link Button
of the algorithm he wants to reference.
Alternatively, the user can use the check-boxes to select multiple algorithms he wants to reference.
After at least one algorithm is selected, a Master Link Button
will appear at the top of the table which can be used to link all selected algorithms with the publication.
Dereference Algorithms
Info
To dereference algorithms, the user has to be in the Algorithms Tab
of the Publication View
, which can be reached by clicking on an implementation in the Implementation List View
.
To remove a reference to a algorithm, the user has to simply click on the Delete Button
of a algorithm in the Actions Column
.
Alternatively, use the check-boxes to select multiple algorithms and then click on the Master Delete Button
to unlink all of them at once.
Note
The Master Delete Button
will only appear if at least one algorithm is selected.
Reference Implementations
Info
To reference implementations in a publication, the user has to be in the Implementations Tab
of the Publication View
, which can be reached by clicking on a publication in the Publication List View
.
To initiate the linking of a publication, the user has to click on the Plus Button
in the Implementations Tab
.
This will open a new dialog containing a page-able table of available publications. This table can be searched or sorted using the given input fields and buttons.
To reference a publication simply click on the Link Button
in the Actions Column
.
Alternatively, use the check-boxes to select multiple publications and then click on the Master Link Button
to link all of them at once.
Note
Master Link Button
will only appear if at least one publication is selected.
Info
Successfully referenced implementation(s) will now be visible in the Implementations Tab
of the Publication View
.
Dereference Implementations
Info
To dereference implementations, the user has to be in the Implementations Tab
of the Publication View
, which can be reached by clicking on an implementation in the Implementation List View
.
To remove a reference to a implementation, the user has to simply click on the Delete Button
of an implementation in the Actions Column
.
Alternatively, use the check-boxes to select multiple implementations and then click on the Master Delete Button
to unlink all of them at once.
Note
The Master Delete Button
will only appear if at least one implementation is selected.
Cloud Service
Create Cloud Service
To create a cloud service the user has to navigate to the Cloud Services List View
by using the navigation sidebar.
This will be done by first clicking on the Execution Environments Menu
in the navigation sidebar, which makes the Cloud Services Sub-Menu
visible.
The Cloud Service List View
contains a data table of all available cloud services. Creating a new cloud service is done via the Plus Button
which is located above the table.
Clicking on the Plus Button
will open the following dialog.
In the dialog it is possible to give the new cloud service a name.
Note
To create a new cloud service only a name
is required.
After all necessary fields have been filled in, the creation of the cloud service can be confirmed by clicking on the OK Button
. In case of a successful creation, the user will be navigated to the Cloud Service View
of the new cloud service.
Delete Cloud Service
Info
To perform the deletion of a cloud service, the user has to be in the Cloud Service List View
.
To remove a specific cloud service, the user has to simply click on the Delete Button
in the Action Column
of the data table.
It is also possible to delete multiple cloud services at once by selecting them one by one using the check-boxes within the table. When at least one cloud service is selected, a Master Delete Button
will show up above the table, which allows the deletion of all selected cloud services.
Both ways of deleting cloud services will lead to a confirmation dialog. This dialog will list all the previously selected cloud services that will be deleted. To finally confirm the deletion, the OK Button
at the bottom of the dialog has to be pressed. In case of a successful deletion, the deleted cloud services will disappear from the table.
Update Cloud Service Information
Info
To update the information of a cloud service, the user has to be in the Cloud Service View
which can be reached by clicking on a cloud service in the Cloud Service List View
.
Updating basic information is done in the General Tab
of the Cloud Service View
. To do that, the user has to simply use the Input fields
, Check-Boxes
or Selection drop-downs
to add new values or adjust existing ones.
If information is changed, a Save Button
will be displayed next that specific input field. Also, a Master Save Button
will appear at the right side of the screen. To save the changes of each input field individually, the user can click on the Save Button
next to any updated input field. Alternatively the user can save all changes by clicking the Master Save Button
.
Note
The user can also hit Enter
on the keyboard to save the changes of a single field in most cases. In some cases, it may be necessary to focus the Save Button
by hitting TAB
on the keyboard and then confirming with Enter
.
Reference Software Platform
Info
To reference software platforms in an existing cloud service, the user has to be in the Software Platforms Tab
of the Cloud Service View
, which can be reached by clicking on a cloud service in the Cloud Service List View
.
In the Cloud Service View
, the user as to switch to theSoftware Platforms Tab
, which is dedicated to referencing software platforms.
To link software platform with the currently selected cloud service, the user has to click on the Plus Button
at the top of the data table.
This will open a dialog with a separate data table containing existing software platforms.
This table can be searched or sorted using the given input fields.
For referencing software platforms the user has to click on the Link Button
of the software platform he wants to reference.
Alternatively, the users can use the check-boxes to select all software platforms he wants to reference.
If it least one software platform is selected a Master Link Button
will appear at the top of the table, which can be used to link all selected software platforms with the cloud service.
Dereference Software Platform
Info
To dereference software platforms, the user has to be in the Software Platforms Tab
of the Cloud Service View
, which can be reached by clicking on a cloud service in the Cloud Service List View
.
To remove the reference to a software platform, the user has to simply click on the Delete Button
in the Actions Column
of the data table.
Alternatively use the check-boxes to select multiple software platforms and then click on the Master Delete Button
to unlink multiple software platforms at once.
Note
Master Delete Button
will only appear if at least one software platform is selected.
Reference Compute Resource
Info
To reference compute resource in an existing cloud service, the user has to be in the Compute Resource Tab
of the Cloud Service View
, which can be reached by clicking on a cloud service in the Cloud Service List View
.
In the Cloud Service View
, the user as to switch to the Compute Resource Tab
, which is dedicated to referencing compute resources.
To link a compute resource with the currently selected cloud service, the user has to click on the Plus Button
at the top of the data table.
This will open a dialog with a separate data table containing existing compute resources.
The table can be searched or sorted using the given input fields and control buttons.
For referencing a compute resource, the user has to click on it's Link Button
.
Alternatively, the user can use the check-boxes to select multiple compute resources he wants to reference.
It at least one compute resource is selected, a Master Link Button
will appear at the top of the table which can be used to link all selected compute resources at once.
Dereference Compute Resource
Info
To dereference compute resources, the user has to be in the Compute Resource Tab
of the Cloud Service View
, which can be reached by clicking on a cloud service in the Cloud Service List View
.
To remove a existing reference to a compute resource, the user has to simply click on the Delete Button
in the Actions Column
of the data table.
Alternatively use the check-boxes to select multiple compute resources and then click on the Master Delete Button
to unlink multiple compute resources at once.
Note
Master Delete Button
will only appear if at least one compute resource has been selected.
Compute Resource
Create Compute Resource
To create a compute resource the user has to navigate to the Execution Environment List View
by using the navigation sidebar.
While in the Execution Environment List View
, the navigation sidebar will display sub menus for different kinds of execution environments. To create a compute resource, the user has to navigate to the Compute Resource List View
.
Inside the Compute Resource List View
, the user can click on the Plus Button
to initiate the creation of a new compute resource inside a separate Creation Dialog
.
Within the Creation Dialog
, the user will have to enter all important information of the compute resource he wants to create.
Note
Currently the only required information is the name of the compute resource.
After entering the name of the compute resource, the user has to confirm the creation by clicking on the OK Button
.
In case the creation was successful, the user will be redirected to the Compute Resource View
of the newly created compute resource.
Delete Compute Resource
Info
To perform the deletion of a compute resource, the user has to be in the Compute Resource List View
.
To remove a specific compute resource, the user has to simply click on the Delete Button
in the Actions Column
of the data table.
The user can also remove multiple compute resources at once by selecting them using the check-boxes of the data table. After the user has made his selection he can press the Master Delete Button
at the top of the data table.
Note
The Master Delete Button
will only appear if at least one compute resource is selected.
To confirm the deletion of the selected compute resource(s), the user has to click on the YES Button
of the Confirmation Dialog
.
Note
Names of the compute resources that will be deleted are displayed in the body of the dialog and should be checked before confirming the deletion.
Update Compute Resource Information
Info
To update the information of a compute resource, the user has to be in the Compute Resource View
which can be reached by clicking on a compute resource in the Compute Resource List View
.
Updating basic information is done in the General Tab
of the Compute Resource View
. To do that, the user has to simply use the Input Fields
, Check-Boxes
or Selection Drop-Downs
to add new values or adjust existing ones.
If information is changed, a Save Button
will be displayed next that specific input field. Also, a Master Save Button
will appear at the right side of the screen. To save the changes of each input field individually, the user can click on the Save Button
next to any updated input field. Alternatively the user can save all changes by clicking the Master Save Button
.
Note
The user can also hit Enter
on the keyboard to save the changes of a single field in most cases. In some cases, it may be necessary to focus the Save Button
by hitting TAB
on the keyboard and then confirming with Enter
.
Info
Compute Resource Properties of are stored separately and therefor do not belong to the basic information of a resource. They are saved, deleted or updated instantly without the use of the mentioned Save Buttons
.
Create Compute Resource Property
Info
To create a property for a compute resource, the user has to be in the Compute Resource View
which can be reached by clicking on a compute resource in the Compute Resource List View
.
Creating properties for a compute resource is done in the General Tab
of the Compute Resource View
. To do that, the user has to simply click on the Plus Button
of the dedicated Compute Resource Property Field
.
This will open a separate Creation Dialog
where the user will have to enter all important information of about the property he wants to create.
Note
The Type Name field supports auto-completion functionality. While typing a type name, the system will suggest existing types with that name in a drop-down. On click of an existing type, all necessary fields will be filled automatically.
After all fields have been filled, the user can finally add the property by confirming the creation via the existing OK Button
.
Note
The Property Value needs to match the selected Data Type.
After the property has been successfully created, it will appear in the the dedicated Compute Resource Property Field
of the Compute Resource View
.
Update Compute Resource Property
Info
To update a property for a compute resource, the user has to be in the Compute Resource View
which can be reached by clicking on a compute resource in the Compute Resource List View
.
Updating properties for a compute resource is done in the General Tab
of the Compute Resource View
. To do that, the user has to simply hover over a existing property in the dedicated Compute Resource Property Field
and then click on the Edit Button
.
This will open a separate Update Dialog
where the information of the property can be adjusted.
Note
The Type Name field supports auto-completion functionality. While typing a type name, the system will suggest existing types with that name in a drop-down. On click of an existing type, all necessary fields will be filled automatically.
After all fields have been adjusted, the user can finally update the property by confirming the update via the existing OK Button
.
Note
The Property Value needs to match the selected Data Type.
Delete Compute Resource Property
Info
To delete a property for a compute resource, the user has to be in the Compute Resource View
which can be reached by clicking on a compute resource in the Compute Resource List View
.
Deleting properties for a compute resource is done in the General Tab
of the Compute Resource View
. To do that, the user has to simply hover over a existing property in the dedicated Compute Resource Property Field
and then click on the Delete Button
.
Info
A successfully deleted property should disappear from the dedicated Compute Resource Property Field
after deletion.
Reference Software Platforms
Info
To reference software platforms in a compute resource, the user has to be in the Software Platforms Tab
of the Compute Resource View
, which can be reached by clicking on a compute resource in the Compute Resource List View
.
To initiate the linking of a software platform, the user has to click on the Plus Button
in the Software Platforms Tab
.
This will open a new dialog containing a page-able table of available software platforms. This table can be searched or sorted using the given input fields and buttons.
To reference a software platform simply click on the Link Button
in the Action-Column
.
Alternatively, use the check-boxes to select multiple software platforms and then click on the Master Link Button
to link all of them at once.
Note
The Master Link Button
will only appear if at least one software platform is selected.
Info
Successfully referenced software platforms(s) will now be visible in the Software Platforms Tab
of the Compute Resource View
.
Dereference Software Platforms
Info
To dereference software platforms, the user has to be in the Software Platforms Tab
of the Compute Resource View
, which can be reached by clicking on a compute resource in the Compute Resource List View
.
To remove a reference from a software platform, the user has to simply click on the Delete Button
of a software platform in the Actions Column
.
Alternatively, use the check-boxes to select multiple software platforms and then click on the Master Delete Button
to unlink all of them at once.
Note
The Master Delete Button
will only appear if at least one software platform is selected.
Reference Cloud Services
Info
To reference cloud services in a compute resource, the user has to be in the Cloud Services Tab
of the Compute Resource View
, which can be reached by clicking on a compute resource in the Compute Resource List View
.
To initiate the linking of a cloud service, the user has to click on the Plus Button
in the Cloud Services Tab
.
This will open a new dialog containing a page-able table of available cloud services. This table can be searched or sorted using the given input fields and buttons.
To reference a cloud service simply click on the Link Button
in the Action-Column
.
Alternatively, use the check-boxes to select multiple cloud services and then click on the Master Link Button
to link all of them at once.
Note
The Master Link Button
will only appear if at least one cloud service is selected.
Info
Successfully referenced cloud service(s) will now be visible in the Cloud Services Tab
of the Compute Resource View
.
Dereference Cloud Services
Info
To dereference cloud services, the user has to be in the Cloud Services Tab
of the Compute Resource View
, which can be reached by clicking on a compute resource in the Compute Resource List View
.
To remove a reference from a cloud service, the user has to simply click on the Delete Button
of a cloud service in the Actions Column
.
Alternatively, use the check-boxes to select multiple cloud services and then click on the Master Delete Button
to unlink all of them at once.
Note
The Master Delete Button
will only appear if at least one cloud service is selected.
Software Platform
Create Software Platform
To create a software platform the user has to navigate to the Execution Environment List View
by using the navigation sidebar.
While in the Execution Environment List View
, the navigation sidebar will display sub menus for different kinds of execution environments. To create a software platform, the user has to navigate to the Software Platform List View
.
Inside the Software Platform List View
, the user can click on the Plus Button
to initiate the creation of a new software platform inside a separate Creation Dialog
.
Within the Creation Dialog
, the user will have to enter all important information of the software platform he wants to create.
Note
Currently the only required information is the name of the software platform.
After entering the name of the software platform, the user has to confirm the creation by clicking on the OK Button
.
In case the creation was successful, the user will be redirected to the Software Platform View
of the newly created software platform.
Delete Software Platform
Info
To perform the deletion of a software platform, the user has to be in the Software Platform List View
.
To remove a specific software platform, the user has to simply click on the Delete Button
in the Actions Column
of the data table.
The user can also remove multiple software platforms at once by selecting them using the check-boxes of the data table. After the user has made his selection he can press the Master Delete Button
at the top of the data table.
Note
The delete button will only appear after at least one software platform has been selected by the user.
To confirm the deletion of the selected software platform(s), the user has to click on the YES Button
of the Confirmation Dialog
.
Note
Names of the software platforms that will be deleted are displayed in the body of the dialog and should be checked before confirming the deletion.
Update Software Platform Information
Info
To update the basic information of a software platform, the user has to be in the Software Platform View
which can be reached by clicking on a software platform in the Software Platform List View
.
Updating basic software platform information is done in the General Tab
of the Software Platform View
. To update a property, the user has to simply use the Input Fields
, Check-Boxes
or Selection Drop-Downs
to add new property values or adjust existing ones.
If a value of a property is changed, a Save Button
will be displayed next that specific input field. Also, a Master Save Button
will appear at the right side of the screen. To save the changes of each input field individually, the user can click on the Save Button
next to any updated input field. Alternatively the user can save all changes by clicking the Master Save Button
.
Note
- The user can also hit
Enter
on the keyboard to save the changes of a single field in most cases. In some cases, it may be necessary to focus theSave Button
by hittingTAB
on the keyboard and then confirming withEnter
. - Some fields are links to other sites. Those can easily be detected by their
Open Button
. On click or onEnter
, it will open the link in a new tab.
Reference Implementations
Info
To reference implementations in a software platform, the user has to be in the Implementations Tab
of the Software Platform View
, which can be reached by clicking on a software platform in the Software Platform List View
.
To initiate the linking of an implementation, the user has to click on the Plus Button
in the Implementation Tab
.
This will open a new dialog containing a page-able table of available implementations. This table can be searched or sorted using the given input fields and buttons.
To reference a implementation simply click on the Link Button
in the Actions Column
of the implementation.
Alternatively use the check-boxes to select multiple implementations and then click on the Master Link Button
to link multiple implementations.
Note
The Master Link Button
will only appear if at least one implementation is selected.
Info
Successfully referenced implementations will now be visible in the Implementations Tab
of the Software Platform View
.
Dereference Implementations
Info
To dereference implementations, the user has to be in the Implementations Tab
of the Software Platform View
, which can be reached by clicking on a software platform in the Software Platform List View
.
To remove a reference from a implementation, the user has to simply click on the Delete Button
in the Actions Column
of the data table.
Alternatively use the check-boxes to select multiple implementations and then click on the Master Delete Button
to unlink multiple implementations.
Note
The Master Delete Button
will only appear if at least one implementation is selected.
Reference Cloud Services
Info
To reference cloud services in a software platform, the user has to be in the Cloud Services Tab
of the Software Platform View
, which can be reached by clicking on a software platform in the Software Platform List View
.
To initiate the linking of a cloud service, the user has to click on the Plus Button
in the Cloud Services Tab
.
This will open a new dialog containing a page-able table of available cloud services. This table can be searched or sorted using the given input fields and buttons.
To reference a cloud service simply click on the Link Button
in the Actions Column
of the cloud service.
Alternatively, use the check-boxes to select multiple cloud services and then click on the Master Link Button
to link all selected cloud services.
Note
The Master Link Button
will only appear if at least one cloud service is selected.
Info
Successfully referenced cloud service(s) will now be visible in the Cloud Services Tab
of the Software Platform View
.
Dereference Cloud Services
Info
To dereference cloud services, the user has to be in the Cloud Services Tab
of the Software Platform View
, which can be reached by clicking on a software platform in the Software Platform List View
.
To remove a reference from a cloud service, the user has to simply click on the Delete Button
in the Actions Column
of the data table.
Alternatively, use the check-boxes to select multiple cloud services and then click on the Master Delete Button
to unlink all selected cloud services.
Note
The Master Delete Button
will only appear if at least one cloud service is selected.
Reference Compute Resources
Info
To reference compute resources in a software platform, the user has to be in the Compute Resources Tab
of the Software Platform View
, which can be reached by clicking on a software platform in the Software Platform List View
.
To initiate the linking of a compute resource, the user has to click on the Plus Button
in the Compute Resources Tab
.
This will open a new dialog containing a page-able table of available compute resources. This table can be searched or sorted using the given input fields and buttons.
To reference a compute resource simply click on the Link Button
in the Action Columns
of the compute resource.
Alternatively, use the check-boxes to select multiple compute resources and then click on the Master Link Button
to link all selected compute resources.
Note
The Master Link Button
will only appear if at least one compute resource is selected.
Info
Successfully referenced compute resource(s) will now be visible in the Compute Resources Tab
of the Software Platform View
.
Dereference Compute Resources
Info
To dereference compute resources, the user has to be in the Compute Resources Tab
of the Software Platform View
, which can be reached by clicking on a software platform in the Software Platform List View
.
To remove a reference from a compute resource, the user has to simply click on the Delete Button
in the Actions Column
of the data table.
Alternatively, use the check-boxes to select multiple compute resources and then click on the Master Delete Button
to unlink all selected compute resources.
Note
The Master Delete Button
will only appear if at least one compute resource is selected.
Application Area
Create Application Area
Info
To create a application area, the user has to be in the Application Area List View
which can be found in the Manage Components Menu
.
Inside the Application Area List View
, the user can click on the Plus Button
to initiate the creation of a new application area inside a separate Creation Dialog
.
Within the Creation Dialog
, the user will have to enter all important information about the application area he wants to create.
Note
Currently the only required information is the name of the application area.
After entering the name of the application area, the user has to confirm the creation by clicking on the OK Button
.
Info
In case of a successful creation, the data table will switch to the last page (if not already) to show the created application area.
Update Application Area
Info
To update a application area, the user has to be in the Application Area List View
, which can be found in the Manage Components Menu
.
Inside the Application Area List View
, the user can choose a application area he wants to update by clicking on it's Edit Button
which can be found in the Actions Column
of the data table.
This will open a Edit Dialog
.
Within the Update Dialog
, the user can adjust the information of the application area.
Note
Currently the only required information is the name of the application area.
After adjusting all information, the user has to confirm the changes by clicking on the OK Button
.
Delete Application Area
Info
To perform the deletion of a application area, the user has to be in the Application Area List View
, which can be found in the Manage Components Menu
.
To delete a specific application area, the user has to simply click on it's Delete Button
in the Actions Column
of the data table.
The user can also remove multiple application areas at once by selecting them using the check-boxes of the data table. After the user has made his selection he can press the Master Delete Button
at the top of the data table.
Note
The Master Delete Button
button will only appear if at least one application area is selected.
To confirm the deletion of the selected application area(s), the user has to click on the YES Button
of the Confirmation Dialog
.
Note
Names of the application area(s) that will be deleted are displayed in the body of the dialog and should be checked before confirming the deletion.
Problem Type
Create Problem Type
Info
To create a problem type, the user has to be in the Problem Type List View
which can be found in the Manage Components Menu
.
Inside the Problem Type List View
, the user can click on the Plus Button
to initiate the creation of a new problem type inside a separate Creation Dialog
.
Within the Creation Dialog
, the user will have to enter all important information about the problem type he wants to create.
Note
- Currently the only required information is the name of the problem type.
- The Parent Problem Type Field is a drop-down that contains all existing problem types that can be optionally set as the parent.
After entering the name of the problem type, the user has to confirm the creation by clicking on the OK Button
.
Info
In case of a successful creation, the data table will switch to the last page (if not already) to show the created problem type.
Update Problem Type
Info
To update a problem type, the user has to be in the Problem Type List View
, which can be found in the Manage Components Menu
.
Inside the Problem Type List View
, the user can choose a problem type he wants to update by clicking on it's Edit Button
which can be found in the Actions Column
of the data table.
This will open a Edit Dialog
.
Within the Update Dialog
, the user can adjust the information of the problem type.
Note
- Currently the only required information is the name of the problem type.
- The Parent Problem Type Field is a drop-down that contains all existing problem types that can be optionally set as the parent.
After adjusting all information, the user has to confirm the changes by clicking on the OK Button
.
Delete Problem Type
Info
To perform the deletion of a problem type, the user has to be in the Problem Type List View
, which can be found in the Manage Components Menu
.
To delete a specific problem type, the user has to simply click on it's Delete Button
in the Actions Column
of the data table.
The user can also remove multiple problem types at once by selecting them using the check-boxes of the data table. After the user has made his selection he can press the Master Delete Button
at the top of the data table.
Note
The Master Delete Button
button will only appear if at least one problem type is selected.
To confirm the deletion of the selected problem type(s), the user has to click on the YES Button
of the Confirmation Dialog
.
Note
Names of the problem type(s) that will be deleted are displayed in the body of the dialog and should be checked before confirming the deletion.
Algorithm Relation Type
Create Algorithm Relation Type
Info
To create a algorithm relation type, the user has to be in the Algorithm Relation Type List View
which can be found in the Manage Components Menu
.
Inside the Algorithm Relation Type List View
, the user can click on the Plus Button
to initiate the creation of a new algorithm relation type inside a separate Creation Dialog
.
Within the Creation Dialog
, the user will have to enter all important information about the algorithm relation type he wants to create.
Note
Currently the only required information is the name of the algorithm relation type.
After entering the name of the algorithm relation type, the user has to confirm the creation by clicking on the OK Button
.
Info
In case of a successful creation, the data table will switch to the last page (if not already) to show the created algorithm relation type.
Update Algorithm Relation Type
Info
To update a algorithm relation type, the user has to be in the Algorithm Relation Type List View
, which can be found in the Manage Components Menu
.
Inside the Algorithm Relation Type List View
, the user can choose a algorithm relation type he wants to update by clicking on it's Edit Button
which can be found in the Actions Column
of the data table.
This will open a Edit Dialog
.
Within the Update Dialog
, the user can adjust the information of the algorithm relation type.
Note
Currently the only required information is the name of the algorithm relation type.
After adjusting all information, the user has to confirm the changes by clicking on the OK Button
.
Delete Algorithm Relation Type
Info
To perform the deletion of a algorithm relation type, the user has to be in the Algorithm Relation Type List View
, which can be found in the Manage Components Menu
.
To delete a specific algorithm relation type, the user has to simply click on it's Delete Button
in the Actions Column
of the data table.
The user can also remove multiple algorithm relation types at once by selecting them using the check-boxes of the data table. After the user has made his selection he can press the Master Delete Button
at the top of the data table.
Note
The Master Delete Button
button will only appear if at least one algorithm relation type is selected.
To confirm the deletion of the selected algorithm relation type(s), the user has to click on the YES Button
of the Confirmation Dialog
.
Note
Names of the algorithm relation type(s) that will be deleted are displayed in the body of the dialog and should be checked before confirming the deletion.
Pattern Relation Type
Create Pattern Relation Type
Info
To create a pattern relation type, the user has to be in the Pattern Relation Type List View
which can be found in the Manage Components Menu
.
Inside the Pattern Relation Type List View
, the user can click on the Plus Button
to initiate the creation of a new pattern relation type inside a separate Creation Dialog
.
Within the Creation Dialog
, the user will have to enter all important information about the pattern relation type he wants to create.
Note
Currently the only required information is the name of the pattern relation type.
After entering the name of the pattern relation type, the user has to confirm the creation by clicking on the OK Button
.
Info
In case of a successful creation, the data table will switch to the last page (if not already) to show the created pattern relation type.
Update Pattern Relation Type
Info
To update a pattern relation type, the user has to be in the Pattern Relation Type List View
, which can be found in the Manage Components Menu
.
Inside the Pattern Relation Type List View
, the user can choose a pattern relation type he wants to update by clicking on it's Edit Button
which can be found in the Actions Column
of the data table.
This will open a Edit Dialog
.
Within the Update Dialog
, the user can adjust the information of the pattern relation type.
Note
Currently the only required information is the name of the pattern relation type.
After adjusting all information, the user has to confirm the changes by clicking on the OK Button
.
Delete Pattern Relation Type
Info
To perform the deletion of a pattern relation type, the user has to be in the Pattern Relation Type List View
, which can be found in the Manage Components Menu
.
To delete a specific pattern relation type, the user has to simply click on it's Delete Button
in the Actions Column
of the data table.
The user can also remove multiple pattern relation types at once by selecting them using the check-boxes of the data table. After the user has made his selection he can press the Master Delete Button
at the top of the data table.
Note
The Master Delete Button
button will only appear if at least one pattern relation type is selected.
To confirm the deletion of the selected pattern relation type(s), the user has to click on the YES Button
of the Confirmation Dialog
.
Note
Names of the pattern relation type(s) that will be deleted are displayed in the body of the dialog and should be checked before confirming the deletion.
Compute Resource Property Type
Create Compute Resource Property Type
Info
To create a compute resource property type, the user has to be in the Compute Resource Property Type List View
which can be found in the Manage Components Menu
.
Inside the Compute Resource Property Type List View
, the user can click on the Plus Button
to initiate the creation of a new compute resource property type inside a separate Creation Dialog
.
Within the Creation Dialog
, the user will have to enter all important information about the compute resource property he wants to create.
Note
- Currently the only required information is the name and the data type of the compute resource property type.
- The Data Type Field is a drop-down that contains all existing data types that can be set.
After entering all required information, the user has to confirm the creation by clicking on the OK Button
.
Info
In case of a successful creation, the data table will switch to the last page (if not already) to show the created compute resource property type.
Update Compute Resource Property Type
Info
To update a compute resource property type, the user has to be in the Compute Resource Property Type List View
, which can be found in the Manage Components Menu
.
Inside the Compute Resource Property Type List View
, the user can choose a compute resource property type he wants to update by clicking on it's Edit Button
which can be found in the Actions Column
of the data table.
This will open a Edit Dialog
.
Within the Update Dialog
, the user can adjust the information of the compute resource property type.
Note
- Currently the only required information is the name and the data type of the compute resource property type.
- The Data Type Field is a drop-down that contains all existing data types that can be set.
After adjusting all information, the user has to confirm the changes by clicking on the OK Button
.
Delete Compute Resource Property Type
Info
To perform the deletion of a compute resource property type, the user has to be in the Compute Resource Property Type List View
, which can be found in the Manage Components Menu
.
To delete a specific compute resource property type, the user has to simply click on it's Delete Button
in the Actions Column
of the data table.
The user can also remove multiple compute resource property types at once by selecting them using the check-boxes of the data table. After the user has made his selection he can press the Master Delete Button
at the top of the data table.
Note
The Master Delete Button
button will only appear if at least one compute resource property type is selected.
To confirm the deletion of the selected compute resource property type(s), the user has to click on the YES Button
of the Confirmation Dialog
.
Note
Names of the compute resource property type(s) that will be deleted are displayed in the body of the dialog and should be checked before confirming the deletion.
Libraries
The component Libraries
is the UI counterpart of the PlanQK Library service.
Settings
Settings can be found by navigating to Settings
in the navigation sidebar.
Note
The visibility of Settings
and related functionalities can be en-/disabled by adapting showSettings
under config/default-config.json
in the cloned quantil-docker repository before running the docker-compose.
Feature Toggling
To enable/disable editing and hide/show the UI components offering the different features of NISQ Analyzer, Pattern Atlas, and QProv, click the related checkboxes.
Logging into the PlanQK Platform
To retrieve data available on the PlanQK platform, click the login button in the top right corner of the UI.
You will be redirected to the login form of the official PlanQK plattform. Enter your credentials and you will be redirected to the QC Atlas UI. In case the login was successful, available algorithms, implementations, etc. are presented in the lists and can be viewed in detail.