Repository navigation
Expand file tree
/
Copy pathindex.qmd
More file actions
255 lines (175 loc) · 7.28 KB
/
Copy pathindex.qmd
File metadata and controls
255 lines (175 loc) · 7.28 KB
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
---
title: "Installation"
# subtitle: "Install Viash, then check out the guide to learn the basics."
format:
html:
include-in-header:
- '_guess_os.html'
page-layout: full
toc: false
anchor-sections: false
css: installation.css
aliases:
- /getting-started/installation.html
---
{{< include ../_includes/_os_chooser.qmd >}}
::: {.grid .step .column-page-right}
::: {.g-col-lg-3 .g-col-12}
## Step 1
#### Install Requirements {.fw-light}
:::
::: {.g-col-lg-9 .g-col-12}
::: {.panel-tabset}
## Linux
Viash is developed in [Scala](https://www.scala-lang.org/), so you'll need to install a Java SE platform, either from [Oracle](https://www.oracle.com/java/technologies/downloads/), or [OpenJDK](https://openjdk.org/projects/jdk/). The minimum required version is Java 11, but we recommend Java 17 or 21 (all of these are Long Time Support versions).
You can run the following command to check if you have Java installed:
```bash
java -version
```
To install Java, we encourage to use your distribution's package manager; `unzip` and `curl` are also required if you want to use the installation script.
```bash
# for Debian/Ubuntu
sudo apt-get update
sudo apt-get install openjdk-17-jdk unzip curl
```
```bash
# for RHEL/Fedora
sudo yum install java-17-openjdk-devel unzip curl
```
```bash
# for Arch
sudo pacman -Syy jdk17-openjdk unzip curl
```
To get the most out of Viash, you'll also need to install [Docker](https://docs.docker.com/engine/install/) and [Nextflow](https://www.nextflow.io/).
:::{.callout-tip}
If you get an error `Docker daemon does not seem to be running` when executing a docker container, you may need to run `sudo systemctl start docker --now` to start the docker service.
To add the current user to the `docker` group, run `sudo usermod -aG docker $USER` and re-login to apply the change.
:::
## macOS
Viash is developed in [Scala](https://www.scala-lang.org/), so you'll need to install a Java SE platform, either from [Oracle](https://www.oracle.com/java/technologies/downloads/), or [OpenJDK](https://openjdk.org/projects/jdk/). The minimum required version is Java 11, but we recommend Java 17 or 21 (all of these are Long Time Support versions).
You can run the following command to check if you have Java installed:
```bash
java -version
```
To install Java, first install Homebrew:
```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
Next install Java 17 by running:
```bash
brew install openjdk@17
```
:::{.callout-tip}
Note that brew may call out that you may want to create a symlink or adjust your PATH.
Please take the appropriate steps as is suitable for your case.
:::
To get the most out of Viash, you'll also need to install [Docker](https://docs.docker.com/desktop/mac/install/) and [Nextflow](https://www.nextflow.io/).
## Windows
Viash doesn't support Windows natively, but [Windows Subsystem for Linux 2](https://docs.microsoft.com/en-us/windows/wsl/about) can be used instead. Follow the instructions below to get everything ready to use Viash:
1. Install WSL2 by following the [instructions provided by Microsoft](https://docs.microsoft.com/en-us/windows/wsl/install). This will install the default distro, **Ubuntu**.
2. Follow [these instructions provided by Docker](https://docs.docker.com/desktop/windows/wsl/) to install **Docker Desktop** with a WSL2 backend. This allows you to run Linux docker containers natively.
3. Open **Ubuntu** from the **Start** menu to start up WSL2.
4. Run the following command in the Ubuntu terminal to upgrade Ubuntu and its packages to the newest version:
```bash
sudo apt-get update && sudo apt-get upgrade -y
```
5. Run this command to check if docker is working correctly:
```bash
docker run hello-world
```
If this doesn't work, read the [Docker WSL2 instructions](https://docs.docker.com/desktop/windows/wsl/) again, you might have missed a step or forgot to reboot your system.
6. Viash is developed in [Scala](https://www.scala-lang.org/), so you'll need to install a Java SE platform, either from [Oracle](https://www.oracle.com/java/technologies/downloads/), or [OpenJDK](https://openjdk.org/projects/jdk/). The minimum required version is Java 11, but we recommend Java 17 or 21 (all of these are Long Time Support versions).
Install the Viash dependencies by executing this command:
```bash
sudo apt-get install -y openjdk-17-jdk unzip zip
```
:::{.callout-note}
You can choose to install `default-jdk` instead of the more explicit `openjdk-17-jdk`.
:::
7. Install [Nextflow](https://www.nextflow.io/).
:::
:::
:::
::: {.grid .step .column-page-right}
::: {.g-col-lg-3 .g-col-12}
## Step 2
#### Install Viash {.fw-light}
:::
::: {.g-col-lg-9 .g-col-12}
::: {.panel-tabset}
## Linux
To install Viash to a `bin` folder on your PATH, run the following command to download and run the install script:
```bash
wget -qO- dl.viash.io | bash
```
```bash
sudo mv viash /usr/local/bin
```
To verify your installation, run the following command:
```bash
viash --help
```
## macOS
Viash can be easily installed in the working directory by running the following command:
```bash
curl -fsSL dl.viash.io | bash
```
This will download the Viash binary to the current working directory and make it executable.
Next, the Viash executable can be moved to either a system location (`/usr/local/bin`) or a user location (`~/bin`):
1. To install the Viash executable to `/usr/local/bin`, simply run:
```bash
sudo mv viash /usr/local/bin
```
Please note that `sudo` rights are required.
2. To install Viash to the `$HOME/bin` folder, run the following command instead:
```bash
mv viash $HOME/bin/viash
```
Make sure to create the `~/bin` directory if it doesn't exist yet and add `~/bin` to the `$PATH` environment variable in your shell.
To verify your installation, run the following command:
```bash
viash --help
```
## Windows
To install Viash to a `bin` folder on your PATH, run the following command to download and run the install script:
```bash
wget -qO- dl.viash.io | bash
```
```bash
sudo mv viash /usr/local/bin
```
To verify your installation, run the following command:
```bash
viash --help
```
:::
:::
:::
::: {.grid .step .column-page-right}
::: {.g-col-lg-3 .g-col-12}
## Step 3
#### Use the Quickstart{.fw-light}
<!-- #### Choose your preferred<br/>scripting language{.fw-light} -->
:::
::: {.tool .g-col-lg-9 .g-col-12}
<!-- <a href="/quickstart/index.html?lang=bash" role="button" class="btn btn-outline-light">
Bash
</a>
<a href="/quickstart/index.html?lang=csharp" role="button" class="btn btn-outline-light">
C#
</a>
<a href="/quickstart/index.html?lang=js" role="button" class="btn btn-outline-light">
JavaScript
</a>
<a href="/quickstart/index.html?lang=python" role="button" class="btn btn-outline-light">
Python
</a>
<a href="/quickstart/index.html?lang=scala" role="button" class="btn btn-outline-light">
Scala
</a>
<a href="/quickstart/index.html?lang=r" role="button" class="btn btn-outline-light">
R
</a> -->
The [Quickstart](/quickstart/) will guide you through the process of creating a Viash component, generating a Nextflow module and incorporating that into a new pipeline.
:::
:::