generated from sipbs-compbiol/sipbs-compbiol-book-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathjoin-session.qmd
76 lines (47 loc) · 4.97 KB
/
join-session.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# Join the Training Session {#sec-join-session}
::: { .callout-tip }
## Use this link to join the training session
- [{{< var galaxy.session >}}]({{< var galaxy.session >}})
Galaxy EU have deployed a dedicated cloud service just for this workshop to use[^1]. No-one outside of our workshop has access to this machine, and all of the jobs in our training session will run on this server Use the link above and log in with your `usegalaxy.eu` account (instructions to set up this account can be found in @sec-galaxy-registration).
[^1]: This is a single server with 120 cores and 205 GB of RAM.
:::
## The Galaxy workspace layout
Once you have joined the session, you will see the Galaxy workspace, which should look similar to @fig-galaxy-workspace. There are three sections to the workspace: the `Tools` sidebar, the `History/Workflow` sidebar, and the central `Workspace` area. You will become more familiar with these as you move through the workshop.
{#fig-galaxy-workspace fig-alt="Screen capture of a Galaxy workspace, with the three sections 'Tools,' 'Workspace,' and 'History/Workflow' indicated." width=80%}
::: { .callout-tip collapse="true" }
## The `Tools` sidebar
The `Tools` sidebar on the left of the window initially presents all the tools available on the Galaxy instance being used. These are grouped into sections by the kind of task they can be used for, such as manipulating text, or assembling sequenced reads.
This sidebar also provides useful links, such as for uploading your own data to the Galaxy instance (`Upload Data`), and for importing data from public databases, like [Ensembl](https://www.ensembl.org/index.html). There is also a search field at the top of the sidebar which initially contains the text `search tools`. You can enter the name of a tool or action into this field, and the sidebar will present the matching software on the Galaxy instance.
:::
::: { .callout-tip collapse="true" }
## The `History/Workflow` sidebar
The `History/Workflow` sidebar at the right of the window will initially be empty. As you work through the exercises this sidebar will become populated with your data, the actions you take on the data, and the results of those actions. The `History` will have no name specified, so you should see the placeholder `Unnamed history`, and the text `This history is empty`.
When you log into a Galaxy instance that you have used before, you may see the most recent history/workflow that you used, and you may have options for loading previous histories/workflows into the current workspace.
:::
::: { .callout-tip collapse="true" }
## The `Workspace`
The largest, central region of the window is the `Workspace`. This is an area that presents several kinds of information. Depending on context, it may provide information about the Galaxy instance, present datasets (or summaries/visualisations of datasets), or ways to interact with the individual tools that you will use.
::: {#fig-workspaces layout-nrow=2 fig-alt="Four images of the Galaxy workspace showing its use in a range of contexts: news and information, inspecting a dataset, interactive visualisation of results, and setting parameters for analysis."}
{#fig-workspace-news}
{#fig-workspace-data}
{#fig-workspace-datavis}
{#fig-workspace-software}
Four uses of the `Workspace` area in Galaxy.
:::
:::
## Give A Name To The History
It is helpful to give the workflow/history that you work with a name. This will help you find it again when you reuse the Galaxy EU instance.
::: { .callout-tip }
- When you name a workflow, give it a concise title that expresses the purpose of the workflow.
- You can also add annotation that describes the workflow and provides more information than the name alone conveys.
- You can rename or re-annotate your workflow at any time.
:::
To assign a name to your workflow:
1. Click on the pen icon next to `Unnamed history`
2. Enter a name for the workflow in the top `Unnamed history` field
3. Enter additional text describing the workflow in the lower `Annotation (optional)` field
4. Click the `Save` button.
::: { .callout-note }
## Video: Renaming A Galaxy Workflow
{{< video assets/movies/galaxy-01-rename-history.mp4 title="Renaming your Galaxy history" >}}
:::