diff --git a/images/accounts/accounts-list.png b/images/accounts/accounts-list.png deleted file mode 100644 index 33ad342cb..000000000 --- a/images/accounts/accounts-list.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:e9b39c5915179ec6cc93ebff7e31a493ca6905813c48ac954eeaa38630a929d1 -size 86540 diff --git a/images/accounts/accounts-list.webp b/images/accounts/accounts-list.webp new file mode 100644 index 000000000..9e917bbf8 --- /dev/null +++ b/images/accounts/accounts-list.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e2f27d62a62834de2cfc3a5443c0700c4ba761afacb601e54fc00ec74877a476 +size 50982 diff --git a/images/ui/entry-gateway.png b/images/ui/entry-gateway.png deleted file mode 100644 index bad7109d0..000000000 --- a/images/ui/entry-gateway.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:c5abc5fb87f8a264e1f844c0c86c8bb2474ee28dc0d998fa37823ac61707a911 -size 167882 diff --git a/images/ui/gateway-query.gif b/images/ui/gateway-query.gif deleted file mode 100644 index 9bcd4e037..000000000 --- a/images/ui/gateway-query.gif +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:633483885a6ac312b8d353794f89ee91e7a312fb7e7e2627d5da07ef1c459fdb -size 1812937 diff --git a/images/ui/homepage.webp b/images/ui/homepage.webp new file mode 100644 index 000000000..9fee1e377 --- /dev/null +++ b/images/ui/homepage.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:10dc0752b4b41dd1917a735a1b9271bc0c97300ba09a34c984c8c26e99f65356 +size 114254 diff --git a/lang/en/docs/accounts/ui/switcher.md b/lang/en/docs/accounts/ui/switcher.md index 2c306f451..b36fdaf75 100644 --- a/lang/en/docs/accounts/ui/switcher.md +++ b/lang/en/docs/accounts/ui/switcher.md @@ -1,21 +1,37 @@ # Account Switcher -The possibility to switch between all Accounts available for login to the user is offered at the top of the [right-hand menu sidebar](../../ui/account-menu.md), under the label `My Accounts` . +The possibility to switch between all Accounts available for login to the user +is offered at the top of the [right-hand menu sidebar]( +../../ui/account-menu.md), under the label `My Accounts` +. ## Currently Logged-in Account -The name and type of the account that the user is currently logged into is displayed in [header](../../ui/header-footer.md). +The name and type of the account that the user is currently logged into is +displayed in [header](../../ui/header-footer.md). ## View My Accounts -If the user is a member of, an [organization](../../collaboration/organizations/overview.md), the "My Accounts" list will contain other accounts, besides his/her personal one. This list is presented using an [Explorer-type interface](../../entities-general/ui/explorer.md), with its associated layout and features. +If the user is a member of, an [organization]( +../../collaboration/organizations/overview.md), the "My Accounts" list will +contain other accounts, besides his/her personal one. This list is presented +using an [Explorer-type interface](../../entities-general/ui/explorer.md), with +its associated layout and features. ## Switch to Account -The user is able to switch between the personal account and organizational accounts by clicking on their corresponding names in the list. When switched, the interface will consequently reflect the change by showing the data related specifically to the organizational account, for example storage quota and balance affecting the wider organization as opposed to the user's personal consumption. +The user is able to switch between the personal account and organizational +accounts by clicking on their corresponding names in the list. When switched, +the interface will consequently reflect the change by showing the data related +specifically to the organizational account, for example storage quota and +balance affecting the wider organization as opposed to the user's personal +consumption. ## Example -In the image below, two accounts are listed in the Account Switcher: a personal account labelled "John Doe", and a wider organizational account called "Exabyte.io". The account under which the user is currently logged in is the personal one. +In the image below, three accounts are listed in the Account Switcher: a +personal account labelled "John Doe", and two organizational accounts called +"Seminar Organization" and "Mat3ra Org". The account under which the user is +currently logged in is the "Seminar Organization". -![Accounts List](../../images/accounts/accounts-list.png "Accounts List") +![Accounts List](../../images/accounts/accounts-list.webp "Accounts List") diff --git a/lang/en/docs/ui/specific/homepage.md b/lang/en/docs/ui/specific/homepage.md index 4e604637e..d5084d9ea 100644 --- a/lang/en/docs/ui/specific/homepage.md +++ b/lang/en/docs/ui/specific/homepage.md @@ -1,54 +1,81 @@ -# Account Homepage / Entry Gateway +# Account Homepage (Entry Gateway) -When the user first logs into our platform, he/she is presented with the **Entry Gateway**. This homepage is presented under the user's **default Account**, which can be modified through the [Account Switcher](../../accounts/ui/switcher.md) by following [this procedure](../../entities-general/actions/set-default.md). The initial screen of the Entry Gateway can be retrieved at all times by clicking the Exabyte Company logo in the [header](../header-footer.md). +When a user first logs into our platform, he/she is presented with the +**Entry Gateway**. This homepage shows a summary of various entities such as +materials, workflows and jobs. + + presented under the user's +**default Account**, which can be modified through the [Account Switcher]( +../../accounts/ui/switcher.md) by following [this procedure]( +../../entities-general/actions/set-default.md). The initial screen of the Entry +Gateway can be retrieved from any page by clicking the Mat3ra Company logo in +the [header](../header-footer.md). ## Initial Options -Immediately after login, the user is first presented with three main options, as displayed in the image below. +Immediately after login, the user is first presented with three main options, as +displayed in the image below. -![Entry Gateway](../../images/ui/entry-gateway.png "Entry Gateway") +![Platform Homepage](../../images/ui/homepage.webp "Platform Homepage") -These initial options can be navigated by clicking their panels, or `Select` buttons. The overall result is a tree diagrams of sequential options, which will be reviewed throughout the rest of this documentation page. +These initial options can be navigated by clicking their panels, or `Select` +buttons. The overall result is a tree diagrams of sequential options, which will +be reviewed throughout the rest of this documentation page. !!!note "Access to platform features" - Numerous features can be accessed directly by opening either the [left-hand](../left-sidebar.md) or [right-hand](../account-menu.md) sidebars. Some options may still be under development. Only features already enabled are reviewed in this page. Please [contact us](../../ui/support.md) if you would like any of these features to be given urgent attention. + Numerous features can be accessed directly by opening either the + [left-hand](../left-sidebar.md) or [account menu](../account-menu.md). + Please [contact us](../../ui/support.md) if you have any features requests. ## Query Bar -A query bar is present on top of the page, allowing the options to be searched at any level. +A query bar is present on top of +the page, allowing the options to be searched at any level. ### Search Tags -This Query bar is populated automatically with tags as the options are selected by the user. The search is performed under the level of the latest tag. +This Query bar is populated automatically with tags as the options are selected +by the user. The search is performed under the level of the latest tag. -All tags can be removed simultaneously by clicking the "X" button on the right-hand side. This reverts the screen to its initial default appearance. Alternatively, each tag can be deleted in turn, which takes the interface up by one level each time. +All tags can be removed simultaneously by clicking the "X" button on the +right-hand side. This reverts the screen to its initial default appearance. +Alternatively, each tag can be deleted in turn, which takes the interface up by +one level each time. ### Search Suggestions -Suggestions are also displayed in real time under the query bar, as new search keywords are being entered. They can be added as tags to the query by clicking them. - -### Animation - -The query functionality is demonstrated in the following animation. Here, we first navigate to the "Run Simulations" option under "Modeling and Simulations", and then we revert back to the original screen by deleting the corresponding tags. - - +Suggestions are also displayed in real time under the query bar, as new search +keywords are being entered. They can be added as tags to the query by clicking +them. ## Modeling and Simulations -The first option allows for the creation of simulation workflows for material modeling. They can be based on any of the supported theoretical [models](../../models/overview.md), operated under the associated computational [methods](../../methods/overview.md) and [applications](../../software-directory/overview.md). +The first option allows for the creation of simulation workflows for material +modeling. They can be based on any of the supported theoretical [models]( +../../models/overview.md), operated under the associated computational +[methods](../../methods/overview.md) and [applications]( +../../software-directory/overview.md). !!!note "Note: labeling of options" - In each flowchart presented in this page, a number or number-letter code is present inside each sub-component. It should be referred to in the headers of their dedicated explanation paragraphs. + In each flowchart presented in this page, a number or number-letter code is + present inside each sub-component. It should be referred to in the headers + of their dedicated explanation paragraphs. ![Modeling Flowchart](../../images/ui/modeling-flowchart.png "Modeling Flowchart") ### 1. Run Simulations -Here, the user can choose to calculate [material properties](../../properties/overview.md) of interest, through the selection of the corresponding workflow template. Examples of pre-defined templates may include total energy calculations, phonon dispersions or electronic bandstructure calculations. +Here, the user can choose to calculate [material properties]( +../../properties/overview.md) of interest, through the selection of the +corresponding workflow template. Examples of pre-defined templates may include +total energy calculations, phonon dispersions or electronic bandstructure +calculations. -A sample of workflow templates included under this option is portrayed in the image below. Clicking any of these available templates creates a new job implementing the workflow, under the default Project of the user's Account. +A sample of workflow templates included under this option is portrayed in the +image below. Clicking any of these available templates creates a new job +implementing the workflow, under the default Project of the user's Account. ![Workflow Templates](../../images/ui/workflow-templates.png "Workflow Templates") @@ -59,70 +86,102 @@ Here, the possibility to design new computational workflows is offered. #### 2A. Density Functional Theory -For example, our platform supports the [Density Functional Theory](../../models-directory/dft/overview.md) (DFT) theoretical framework for executing electronic structure calculations, as implemented by the [Quantum ESPRESSO](../../software-directory/modeling/quantum-espresso/overview.md) or [VASP](../../software-directory/modeling/vasp/overview.md) applications. Plans are under way to expand the offer to new atomistic simulation approaches, such as the classical Molecular Dynamics and Multi-scale techniques. +For example, our platform supports the [Density Functional Theory]( +../../models-directory/dft/overview.md) (DFT) theoretical framework for +executing electronic structure calculations, as implemented by the +[Quantum ESPRESSO](../../software-directory/modeling/quantum-espresso/overview.md) +or [VASP](../../software-directory/modeling/vasp/overview.md) applications. +Plans are under way to expand the offer to new atomistic simulation approaches, +such as the classical Molecular Dynamics and Multi-scale techniques. ### 3. Connect Remotely -In this section, users can connect to our computational engine through alternative channels, other than our graphical user interface-based platform. +In this section, users can connect to our computational engine through +alternative channels, other than our graphical user interface-based platform. -In future, further remote connection interfaces will be offered to our customers, including for example the Jupyter web-based python environment provided with a set of pre-loaded libraries and tools. +In future, further remote connection interfaces will be offered to our +customers, including for example the Jupyter web-based python environment +provided with a set of pre-loaded libraries and tools. #### 3A. Command Line Terminal -The first remote connection method consists in the [Command Line interface/remote-connection/overview.md) (option "3A"). +The first remote connection method consists in the [Command Line interface]( +../../remote-connection/web-terminal.md) (option "3A"). #### 3B. Remote Desktop -Alternatively, the [Remote Desktop environment](../../remote-connection/remote-desktop.md) (option "3B") can also be employed. +Alternatively, the [Remote Desktop environment]( +../../remote-connection/remote-desktop.md) (option "3B") can also be employed. ## Machine Learning -The Machine Learning functionality offered by our platform can be accessed as the second main option. Such functionality affords for the building of data-driven statistical models, based on results of materials simulations. The techniques implemented in our platform are the object of a [dedicated tutorial](../../tutorials/ml/train-ml-model.md). +The Machine Learning functionality offered by our platform can be accessed as +the second main option. Such functionality affords for the building of +data-driven statistical models, based on results of materials simulations. The +techniques implemented in our platform are the object of a [dedicated tutorial]( +../../tutorials/ml/train-ml-model.md). -Machine Learning allows to predict new material properties by applying previously-trained models. In addition, new models can be trained by designing appropriate workflows, or use some of their pre-defined templates. +Machine Learning allows to predict new material properties by applying +previously-trained models. In addition, new models can be trained by designing +appropriate workflows, or use some of their pre-defined templates. !!! note "Limited availability" - Machine learning is a feature under active development and has a proof-of-concept status. Some items below may not be available yet. + Machine learning is a feature under active development and has a + proof-of-concept status. Some items below may not be available yet. ![Machine Learning Flowchart](../../images/ui/ml-flowchart.png "Machine Learning Flowchart") ### 2. Train New Model -New models can be created under this option, by either designing new training workflows or using a pre-defined template. +New models can be created under this option, by either designing new training +workflows or using a pre-defined template. #### 2A. Regression linear -This option allows for the building of a predictive model using the linear regression method. Selecting this option creates the corresponding workflow under a new job inside the default Project. +This option allows for the building of a predictive model using the linear +regression method. Selecting this option creates the corresponding workflow +under a new job inside the default Project. ## Data Analytics -"Data analytics" option gives the user the possibility to interact with data as explained below. +"Data analytics" option gives the user the possibility to interact with data as +explained below. ![Data Analytics Flowchart](../../images/ui/data-flowchart.png "Data Analytics Flowchart") ### 1. Upload/import -Here, the user can upload or import a new material into the Account-owned collection from multiple external sources. +Here, the user can upload or import a new material into the Account-owned +collection from multiple external sources. #### 1A. Upload Material from File -This option gives the user the possibility to [upload](../../materials/actions/upload.md) one or multiple local files containing the relevant crystallographic information about the material under investigation. We support the CIF, POSCAR and XYZ crystal structure data formats. +This option gives the user the possibility to [upload]( +../../materials/actions/upload.md) one or multiple local files containing the +relevant crystallographic information about the material under investigation. We +support the CIF, POSCAR and XYZ crystal structure data formats. #### 1B. Import from a Web Database -We have made the third-party "Materials Project" repository of materials available to the users of our platform. The materials contained there can thus be [imported](../../materials/actions/import.md) into the Account-owned collection. +We have made the third-party "Materials Project" repository of materials +available to the users of our platform. The materials contained there can thus +be [imported](../../materials/actions/import.md) into the Account-owned +collection. Support for other databases will be added in future. ### 2. Analyze Data -This features allows materials to be [searched](../../entities-general/actions/search.md) and inspected by the user. +This features allows materials to be [searched]( +../../entities-general/actions/search.md) and inspected by the user. #### 2A. Search my Materials -This option searches only within the limits of the Account-owned collection of materials. +This option searches only within the limits of the Account-owned collection of +materials. #### 2B. Search all Materials -Publicly available materials, originating from across the entire platform, can be searched and analyzed collectively with this option. +Publicly available materials, originating from across the entire platform, can +be searched and analyzed collectively with this option.