diff --git a/docs/source/agui/._fig1_gui.png b/docs/source/agui/._fig1_gui.png new file mode 100644 index 0000000000000000000000000000000000000000..b404ad510c2bde06a3e89557449d7e0353ee6ddb Binary files /dev/null and b/docs/source/agui/._fig1_gui.png differ diff --git a/docs/source/agui/._fig_experiment.jpg b/docs/source/agui/._fig_experiment.jpg index f4d10552d85fa652cb6bc97a6c46e6f340a2bc14..08c2a053def811e48a77820d0ffe6bd1cbeb2bc7 100644 Binary files a/docs/source/agui/._fig_experiment.jpg and b/docs/source/agui/._fig_experiment.jpg differ diff --git a/docs/source/agui/._fig_graph_2.jpg b/docs/source/agui/._fig_graph_2.jpg new file mode 100644 index 0000000000000000000000000000000000000000..992c35e9bf51f4eb369a42cd1856fe93be9ebc11 Binary files /dev/null and b/docs/source/agui/._fig_graph_2.jpg differ diff --git a/docs/source/agui/._fig_performance_1.jpg b/docs/source/agui/._fig_performance_1.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5d892c20dd15243ad776079c7e230c9e89ae7c23 Binary files /dev/null and b/docs/source/agui/._fig_performance_1.jpg differ diff --git a/docs/source/agui/._fig_tree_2.jpg b/docs/source/agui/._fig_tree_2.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3d00ac44d69875e3f16d2410e866e43da886ca9d Binary files /dev/null and b/docs/source/agui/._fig_tree_2.jpg differ diff --git a/docs/source/agui/experiment.rst b/docs/source/agui/experiment.rst index c9b56e40e6a0b25cb694d7f520b3edc2c23e9563..9881d923ccd79aca78e9b7842c6be8e39c155fcb 100644 --- a/docs/source/agui/experiment.rst +++ b/docs/source/agui/experiment.rst @@ -13,8 +13,8 @@ This component offers the main information about your experiment. Experiment Information -At the top left you see the ``Autosubmit Searcher`` home link that will take you back to the :ref:`autosubmitGUIMP`, next to it you see the ``Home`` link that serves the same purpose, then you see the ``About`` link that takes you to a page with important information about the application (including the link to this documentation). Then you see the experiment name and ``status``, which is updated every 5 minutes. +At the top left you see the ``Autosubmit Searcher`` home link that will take you back to the :ref:`autosubmitGUIMP`, next to it you see the ``Home`` link that serves the same purpose, then you see the ``About`` link that takes you to a page with important information about the application (including the link to this documentation). Then you see the experiment name and ``status``, which is updated every 5 minutes. Next, you see the `run history` button, this button opens a panel that shows information about previous runs of the experiment, only works for experiments running the latest version of Autosubmit. Then, you see the ``esarchive status`` badge, it shows information about the current status of the `esarchive` file system. -At the bottom you see some relevant metadata, including the ``branch`` of the ``model`` that was used in the experiment, the ``HPC name`` targeted by the experiment, the owned, and the last time the experiment folder was modified, which probably coincides with the creation date of the experiment. +At the bottom you see some relevant metadata, including the ``branch`` of the ``model`` that was used in the experiment, the ``HPC name`` targeted by the experiment, the owner, the ``version`` that this experiment us running on, the ``DB`` version of Autosubmit, and the number of jobs in the experiment. On the center you see the :ref:`treeRepresentation`, which is loaded automatically when you open this page. \ No newline at end of file diff --git a/docs/source/agui/fig1_gui.png b/docs/source/agui/fig1_gui.png index 1cafef5602002993f2f2b3d73863a9ee7d62c4c6..d470a265d616dde269ff312cf64a9a07ae7db684 100644 Binary files a/docs/source/agui/fig1_gui.png and b/docs/source/agui/fig1_gui.png differ diff --git a/docs/source/agui/fig_experiment.jpg b/docs/source/agui/fig_experiment.jpg index 8927307265e14e057b0e115faea6c324461ff9a4..e913e397d009c97035c2d2d2fad81c29a719b407 100644 Binary files a/docs/source/agui/fig_experiment.jpg and b/docs/source/agui/fig_experiment.jpg differ diff --git a/docs/source/agui/fig_graph_2.jpg b/docs/source/agui/fig_graph_2.jpg index e302d82d745d00ab630a38628fc7971404ee207f..f3aa2a158765aacd735782c6d9ca0ed18ac406d9 100644 Binary files a/docs/source/agui/fig_graph_2.jpg and b/docs/source/agui/fig_graph_2.jpg differ diff --git a/docs/source/agui/fig_performance_1.jpg b/docs/source/agui/fig_performance_1.jpg new file mode 100644 index 0000000000000000000000000000000000000000..db2e7188ae2f165b9b41667e1e5b83d4598510e2 Binary files /dev/null and b/docs/source/agui/fig_performance_1.jpg differ diff --git a/docs/source/agui/fig_tree_2.jpg b/docs/source/agui/fig_tree_2.jpg index cb1ba8593979246e494e3933151c74ff2e79e935..3876687f0862a0f1069c00e1b492de6f83146e7e 100644 Binary files a/docs/source/agui/fig_tree_2.jpg and b/docs/source/agui/fig_tree_2.jpg differ diff --git a/docs/source/agui/graph.rst b/docs/source/agui/graph.rst index f8c3af5a74f9b425423f2aa7c55183a3be6aad42..483826798919614bc6d97fe44b8d234a064d8161 100644 --- a/docs/source/agui/graph.rst +++ b/docs/source/agui/graph.rst @@ -21,12 +21,13 @@ Once the graph representation is loaded, it will focus on a relevant node accord When you click on a node, you can see on the right panel (**Selection Panel**) the following information: -- *Initial*: Initial date as in the one used for grouping. -- *Real*: Real date after adding to the initial date the number of chunk units depending on chunk size. +- *Start*: Starting date. +- *End*: Ending date. - *Section*: Also known as job type. - *Member* - *Chunk* -- *Platform*: HPC Platform. +- *Platform*: Remote platform. +- *Id*: Id in the remote platform. - *Processors*: Number of processors required by the job. - *Wallclock*: Time requested by the job. - *Queue*: Time spent in queue, in minutes. @@ -36,6 +37,18 @@ When you click on a node, you can see on the right panel (**Selection Panel**) t - *In*: Button that opens a list of jobs on which the selected job depends. - *out path*: Path to the .out log file. - *err path*: Path to the .err log file. +- *Submit*: Submit time of the job (If applicable). +- *Start*: Start time of the job (If applicable). +- *Finish*: Finish time of the job (If applicable). + +.. important:: Next to the **out** and **err** paths, you see the a ``Copy out/err`` button that copies the path to your clipboard. Then you see an ``eye symbol`` button, that when clicked will show that last 150 lines of the **out/err** file. + +Selection +--------- + +When you click on a node in the tree view, a ``Change Status`` button will appear in the top bar, if you click, you will be presented with the option to generate a change status command that can be run on autosubmit, or to generate a format that can be used to change the status of the job while the experiment is running. + +You can select many nodes at the same time by maintaining ``CTRL`` pressed and clicking on the nodes, then the generated command will include all these jobs. Wrappers Representation ----------------------- diff --git a/docs/source/agui/performance.rst b/docs/source/agui/performance.rst new file mode 100644 index 0000000000000000000000000000000000000000..ab34739ad4f197165c091dc1d15712fd9448dc2e --- /dev/null +++ b/docs/source/agui/performance.rst @@ -0,0 +1,20 @@ +.. _performance: + +Performance Metrics +=================== + +The Performance Metrics tabs offers a set of metrics that try to measure the efficiency of the simulation performed, and other aspects of it. + +.. figure:: fig_performance_1.jpg + :name: experiment_performance + :width: 100% + :align: center + :alt: Performance Metrics 1 + + Performance Metrics Tab + +On the left you have the values of the main performance metrics that apply to the experiment. Then, on the right, you see the list of jobs considered for this calculation with their data, also, ``SYPD`` and ``ASYPD`` are calculated individually for these jobs. This list is scrollable. + +You can also access a ``Show warnings`` button that opens a list of important information that might affect the calculation of the metrics. You can click again on this button to close the list. + +Further information about the metrics is included in the tab. \ No newline at end of file diff --git a/docs/source/agui/tree.rst b/docs/source/agui/tree.rst index 88e4eac4ba9c8d1427ecba75ce4de4552ef3bf9e..70d2945dffc0fa115d9abf0e0e80f2fbb0f83794 100644 --- a/docs/source/agui/tree.rst +++ b/docs/source/agui/tree.rst @@ -19,12 +19,13 @@ Inside each group you will find the list of jobs that belong to that group. The When you click on a Job, you can see on the right panel (**Selection Panel**) the following information: -- *Initial*: Initial date as in the one used for grouping. -- *Real*: Real date after adding to the initial date the number of chunk units depending on chunk size. +- *Start*: Starting date. +- *End*: Ending date. - *Section*: Also known as job type. - *Member* - *Chunk* -- *Platform*: HPC Platform. +- *Platform*: Remote platform. +- *Id*: Id in the remote platform. - *Processors*: Number of processors required by the job. - *Wallclock*: Time requested by the job. - *Queue*: Time spent in queue, in minutes. @@ -32,10 +33,20 @@ When you click on a Job, you can see on the right panel (**Selection Panel**) th - *Status*: Job status. - *Out*: Button that opens a list of jobs that depend on the one selected. - *In*: Button that opens a list of jobs on which the selected job depends. -- *Wrapper*: If the job belongs to a wrapper, the name of the wrapper will be shown. -- *Code*: Code of the wrapper the job belongs to, for easy searching. - *out path*: Path to the .out log file. - *err path*: Path to the .err log file. +- *Submit*: Submit time of the job (If applicable). +- *Start*: Start time of the job (If applicable). +- *Finish*: Finish time of the job (If applicable). + +.. important:: Next to the **out** and **err** paths, you see the a ``Copy out/err`` button that copies the path to your clipboard. Then you see an ``eye symbol`` button, that when clicked will show that last 150 lines of the **out/err** file. + +Selection +--------- + +When you click on a job in the tree view, a ``Change Status`` button will appear in the top bar, if you click, you will be presented with the option to generate a change status command that can be run on autosubmit, or to generate a format that can be used to change the status of the job while the experiment is running. + +You can select many jobs at the same time by maintaining ``CTRL`` pressed and clicking on the jobs, then the generated command will include all these jobs. Monitoring ---------- diff --git a/docs/source/autosubmit-gui.rst b/docs/source/autosubmit-gui.rst index 71574f070b74f7a3bfab8b66bc2c7256c643b448..e10ec1bca3c60c68413844f169255ebe67e7e3a7 100644 --- a/docs/source/autosubmit-gui.rst +++ b/docs/source/autosubmit-gui.rst @@ -6,7 +6,7 @@ Autosubmit GUI Autosubmit GUI Main Page ======================== -Inside the Barcelona Supercomputing Internal Network you can find the latest version of Autosubmit GUI deployed for BSC users. It can be accessed by following the url http://bscesweb04.bsc.es/autosubmitapp/. This is a graphic user interface that allows you to easily monitor your experiments and those of your colleagues. This Web App introduces many useful features for experiment monitoring, and we are continuously improving it. +Inside the Barcelona Supercomputing Internal Network you can find the latest version of Autosubmit GUI deployed for BSC users. It can be accessed by following the url http://bscesweb04.bsc.es/autosubmitapp/ or https://earth.bsc.es/autosubmitapp/. This is a graphic user interface that allows you to easily monitor your experiments and those of your colleagues. This Web App introduces many useful features for experiment monitoring, and we are continuously improving it. .. note:: The Web App can also be accessed through the VPN Client provided by BSC. @@ -82,6 +82,7 @@ After clicking on the **MORE** button, you will be presented with the **Experime agui/tree agui/graph agui/log + agui/performance agui/statistics .. important:: To improve response times, Autosubmit GUI will try to store the dependency structure of your experiment in a database filed called ``structure_expid.db`` where ``expid`` is the name of your experiment. This file will be located in ``/esarchive/autosubmit/expid/pkl/``. \ No newline at end of file diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 63c440362cc735bfb58253a1b24e4b83fbc851bd..8e727d0a4f27c106df84fe8ca183f450e5deeb30 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -33,6 +33,7 @@ Command list usage/check usage/describe usage/run + usage/run_members usage/start_time usage/start_after usage/inspect diff --git a/docs/source/usage/run_members.rst b/docs/source/usage/run_members.rst new file mode 100644 index 0000000000000000000000000000000000000000..6f9a90443e1da764eb9bb03d80adfabdf75c3b26 --- /dev/null +++ b/docs/source/usage/run_members.rst @@ -0,0 +1,26 @@ +How to run only selected members +================================ + +To run only a subset of selected members you can execute the command: +:: + + autosubmit run EXPID -rm MEMBERS + +*EXPID* is the experiment identifier, the experiment you want to run. + +*MEMBERS* is the selected subset of members. Format `member1 member2 member2`, example: `fc0 fc1 fc2`. + +Then, your experiment will start running jobs belonging to those members only. If the experiment was previously running and autosubmit was stopped when some jobs belonging to other members (not the ones from your input) where running, those jobs will be tracked and finished in the new exclusive run. + +Furthermore, let's say you wish to run a sequence of only members execution. Then, instead of running `autosubmit run -rm member_1` ... `autosubmit run -rm member_n`, you can make a bash file with that sequence and run the bash file. Example: +:: + + #!/bin/bash + autosubmit run EXPID -rm MEMBER_1 + autosubmit run EXPID -rm MEMBER_2 + autosubmit run EXPID -rm MEMBER_3 + ... + autosubmit run EXPID -rm MEMBER_N + + +