Skip to content

Commit 6c82a42

Browse files
authored
Kkmattil sd installer (#1728)
* Create sd-software-installer.md * Create rstudio.md * Update sd-software-installer.md * Create whisper.md * Update sd-software-installer.md * Update sd-software-installer.md * Update sd-software-installer.md * Update sd-software-installer.md * Update sd-software-installer.md * Update whisper.md * Create auto-apptainer.md * Update auto-apptainer.md * Update auto-apptainer.md * Update auto-apptainer.md * Create vscode.md * Update sd-software-installer.md * Update sd-software-installer.md * Update sd-software-installer.md * Update sd-software-installer.md * Update sd_desktop.md * Update sd-software-installer.md * Update vscode.md * Update auto-apptainer.md * Update sd-software-installer.md * Update rstudio.md * Update sd-software-installer.md * Delete sd-installer2.png * Add files via upload * Delete sd-installer2.png * Add files via upload * Update sd-software-installer.md fixed a typo
1 parent f7c80e8 commit 6c82a42

File tree

7 files changed

+257
-2
lines changed

7 files changed

+257
-2
lines changed
60 KB
Loading

docs/data/sensitive-data/sd_desktop.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -335,11 +335,15 @@ Each virtual Desktop (or virtual computer) is pre-built and contains a limited s
335335
* R + RStudio Server versions matched with Puhti r-env-singularity module (R 4.0.5 + RStudio Server 1.4.1106, MRAN, Bioconductor 3.12)
336336
* [Rstudio 4.2.2 and all CRAN and Bioconductor libraries can be added with SD-software-installer](./r-in-sd-desktop.md)
337337

338+
### SD Software installer
339+
340+
[SD Software installer](./tutorials/sd-software-installer.md) provides easy-to-use tool to add some commonly used software to SD Desktop.
341+
338342
### Software customisation
339343

340-
Users can install their user-level software to SD Desktop, but this requires technical expertise. As SD Desktop is isolated from the internet, you can't directly use installation tools like _git_, _coda_, _cpan_ or _pip_ as they are dependent on internet connections to external repositories. Further, SD Desktop users can't do any operation that needs superuser access.
344+
Users can install their own software to SD Desktop, but this requires technical expertise. As SD Desktop is isolated from the internet, you can't directly use installation tools like _git_, _coda_, _cpan_ or _pip_ as they are dependent on internet connections to external repositories. Further, SD Desktop users can't do any operation that needs superuser access.
341345

342-
The most convenient way to add new software to your SD Desktop is to build a Singularity container outside SD Desktop and then import the Singularity image through SD Connect to SD Desktop. The two documents below describe two sample cases on adding software with containers.
346+
If you want to add new software to your virtual machine independently, the most convenient way to add new software to your SD Desktop is to build a Singularity container outside SD Desktop and then import the Singularity image through SD Connect to SD Desktop. The two documents below describe two sample cases on adding software with containers.
343347

344348
1. [Importing ready-made software containers from a public repository to SD Desktop](./sd-desktop-singularity.md)
345349
2. [Creating you own Singularity container and importing it to SD Desktop](./creating_containers.md)
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Auto-apptainer
2+
3+
Auto-apptainer is a help tool that can be used to add software to a SD Desktop virtual machine. It utilizes a library of
4+
of Apptainer based software contaners, pre-loaded by CSC. You can suggest a container to be added to the library.
5+
6+
Auto apptainer is not available by default, but you must install it first using [SD Software installer](./sd-software-installer.md).
7+
After that you can lauch the tool with command:
8+
9+
```test
10+
auto-apptainer
11+
```
12+
By deafault, this lists all the Apptainer packages available. From the list you can select the backage to be installed.
13+
14+
Alternatively you can add a fltering criteria to the command. In this case only those containers whose name or one
15+
of commands that the container provides, matches the search creiteria, are listed.
16+
17+
For example command :
18+
19+
```test
20+
auto-apptainer bam
21+
```
22+
23+
asks the user to choose from two contaiers: _bamtools_ and _bedtools_. Bedtools is included as it provides commands _bamToBed_ and _bamToFasta_ that match the serach criteria in this case.
24+
25+
Once a container is selected, one more apptainer warpper based commands are created to drectory: _/shared-directory/sd-tools/bin_.
26+
These commands can mostly be used like natively installed commands. For example after installing the Bamtools container,
27+
Bamtools can be startted with command:
28+
29+
```text
30+
bamtools
31+
```
32+
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Adding Rstudio and R libraries to SD Desktop #
2+
3+
Using R and Rstudio in SD Desktop virtual machines is based on a singularity container that
4+
contains R and Rsudio installations and over 1000 commonly used R libraries. However, as there
5+
are nearly 20 000 libraries in the CRAN repository and over 2000 libraries in the Bioconductor
6+
repository, it is quite common that some library that you would like to use, is not included in the default selection.
7+
8+
This document describes the usage of help tools that you can use to add Rstudio 4.2.2 and missing R libraries to your SD Desktop environment.
9+
The process described here is the first prototype implementation of this service and it is likely the change in the future.
10+
11+
## Requirements ##
12+
13+
In order to get access to the installation tool, you need to **send a request to servicedesk@csc.fi**.
14+
In the request, indicate that you wish that the SD Desktop software installation help tools would be made available for your project.
15+
You must also include to the message the **Project identifier string** of your project.
16+
17+
You can check this random string for example in the [SD Connect service](https://sd-conenct.csc.fi). There you find the
18+
Project Identifier in the **User information** view.
19+
20+
21+
## Installing Rstudio 4.2.2 ##
22+
23+
Log in to your SD Desktop and open **Data Gateway**. If the software installation help tools are enabled for your project, then you should have folder:
24+
**tools-for-sd-desktop** included in the directory that Data Gateway created ( in Projects/SD Coonnect/_your-project-name_).
25+
Open _tools-for-sd-desktop_ folder and from there, drag/copy file **sd-installer.desktop** to your desktop.
26+
27+
[![Installing-sd-installer](../images/desktop/sd-installer1.png)](../images/desktop/sd-installer1.png)
28+
29+
**Figure 1.** Copying sd-installer.desktop file to SD desktop.
30+
31+
Double click the copy of _sd-installer.desktop_ to start the software installation tool. Use this tool to install _Rstudio 4.2.2_
32+
to your SD Desktop virtual machine if you have not yet done so. The installation takes several minutes.
33+
34+
[![sd-installer](../images/desktop/sd-installer2.png)](../images/desktop/sd-installer2.png)
35+
36+
**Figure 2.** SD software installation tool.
37+
38+
Once the installation is done you can start Rstudio by clicking the Rstudio icon in the desktop or by executing command:
39+
40+
```text
41+
start-rstudio
42+
```
43+
44+
## Adding missing R libraries ##
45+
46+
Once the Rstudio environment is installed, new libraries can be added by opening a terminal and executing command:
47+
```text
48+
add-R-library
49+
```
50+
51+
The command asks for a search term and shows the available R libraries that match the search string.
52+
If several libraries are found, you will be provided an enumerated list from which you can
53+
select the library that should be installed.
54+
55+
This tool does not check for internal library dependencies, and quite often the first installation attempt fails.
56+
In these cases you should check the names of the missing libraries and install them first.
57+
58+
For example, search term _fusion_ finds 8 libraries. In this case we want to install _DNAfusion_ (DNAfusion_1.0.0.tar.gz),
59+
that is listed as the first in the list so the installation started by pressing _1_ and then _Enter_.
60+
61+
In this case, the installation however fails as DNAfusion depends on a library which is not yet installed.
62+
In this kind of situations you need to check the names of the missing libraries from the error message and install them first.
63+
You can give the name of the library as an argument to the add-R-library command.
64+
For example in this case the missing library, _bamsignals_, can be added with command:
65+
```text
66+
add-R-library bamsignals
67+
```
68+
69+
After which you can install DNAfusion
70+
71+
```text
72+
add-R-library DNAfusion
73+
```
74+
75+
The additional libraries are installed to location ”/shared-directory/sd-toold/apps/R/lib” where they are available for
76+
all the users of the virtual machine. This is not a default location of R libraries so you must define the location in your
77+
R code with command:
78+
79+
```text
80+
.libPaths(”/shared-directory/sd-tools/apps/R/lib/”)
81+
```
82+
83+
After that you can take the library in use. e.g.
84+
85+
```text
86+
library(DNAfusion)
87+
```
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# SD Desktop Software Installer
2+
3+
As SD desktop virtual machines are isolated from internet, installing additional software and libraries
4+
to your virtual machine is not straight forward. Adding extra software is possible, but it requires that
5+
you convert the installation processes into files that can be uploaded to SD Connect and from there
6+
copied to your SD Desktop environment for installation and usage.
7+
8+
In generally, we recommend using Apptainer containers for importing the software you need.
9+
10+
To make additional software installations easier, CSC has created **SD Software Installer** tool,
11+
that provides an easy way to add few commonly used software packages and help tools to your virtual machine.
12+
This document describes the usage of this help tool.
13+
14+
15+
## Requirements ##
16+
17+
In order to get access to the installation tool, you need to **send a request to servicedesk@csc.fi**.
18+
In the request, indicate that you wish that the SD software installer would be
19+
made available for your project. You must include the **Project identifier string** of your project to the request.
20+
You can check this 32 characters long random string for example in the [SD Connect service](https://sd-conenct.csc.fi).
21+
There you find the Project Identifier in the **User information** view.
22+
23+
## Installing the SD Software Installer ##
24+
25+
Log in to your SD Desktop and open **Data Gateway**. If the software installation help tools are enabled for your project,
26+
then you should have folder **tools-for-sd-desktop** included in the directory that Data Gateway created
27+
( in Projects/SD-Connect/_your-project-name_).
28+
29+
Open _tools-for-sd-desktop_ folder and from there, drag/copy file **sd-installer.desktop** to your desktop.
30+
31+
[![Installing-sd-installer](../images/desktop/sd-installer1.png)](../images/desktop/sd-installer1.png)
32+
33+
**Figure 1.** Copying sd-installer.desktop file to SD desktop.
34+
35+
Double click the copy of _sd-installer.desktop_ to start the software installation tool. In Ubuntu based VMs you
36+
need to right-click the and select _Allow Launching_ before you can use the _sd-installer.desktop_.
37+
38+
[![sd-installer](../images/desktop/sd-installer2.png)](../images/desktop/sd-installer2.png)
39+
40+
**Figure 2.** SD Software installer
41+
42+
43+
## Usage ##
44+
45+
In order to use the installer, you must have an active Data Gateway connection running and
46+
mounting of the SD Conncect data should be done through the default location in the file system
47+
(_Projects_ directory in the users home directory).
48+
49+
The installer shows a panel of buttons that allow you to install a software by just cliking the button.
50+
The available software include graphical and command line applications. For graphical applications, a launching icon is added
51+
to the desktop. All software is installed to directory _/shared-directory/sd-tools/_ where the installaion is availale for all the
52+
users of the virtual machine.
53+
54+
In case of some applications, part of the installation process occurs only when the application is started for the first time.
55+
Thus you should start the application once after the installation, to make sure that the prcess is completed. After that
56+
the installaled software should work also when Data Gateway connection has not been opened.
57+
58+
59+
## Tool selection ##
60+
61+
Notes about the available tools. Note that this list may be out-dated:
62+
63+
### Statistics
64+
* [Rstudio 4.2.2](rstudio.md) R statistics tool with graphcal user interface and help tools for adding libraries.
65+
* [PSPP](https://www.gnu.org/software/pspp/) Open Source alternative for SPSS statistics tool.
66+
67+
### Imaging and vidos
68+
* [Audacity](https://www.audacityteam.org/). Sound editor.
69+
* [OpenShot 3.1.1](https://www.openshot.org/). Video editor.
70+
* This tool works only in Ubuntu22 based VMs.
71+
* After installation, right click the OpenShot desktop icon and select: _Run as a program_.
72+
* [QuPath 0.4.2](https://github.com/qupath/qupath/). Software for bioimage analysis.GATL
73+
* [Whisper](whisper.md) Automatic speech recognition.
74+
75+
### Geosciences
76+
* [QGis 3.1.1](https://qgis.org/en/site/) A Free and Open Source Geographic Information System.
77+
* [QGis at CSC servers](../../../apps/qgis.md)
78+
79+
### Biosciences
80+
* [GATK](https://gatk.broadinstitute.org/hc/en-us) A genomic analysis toolkit focused on variant discovery.
81+
* [MultiQC 1.10](https://multiqc.info/) NGS Read quolity checking tool.
82+
* [Salmon 1.9.0](https://combine-lab.github.io/salmon/) Program to produce transcript-level quantification estimates from RNA-seq data
83+
* [Salmon 1.9.0 at CSC servers](../../../apps/salmon.md)
84+
85+
### Miscallenius
86+
* [auto-apptainer](./auto-apptainer.md) Tool to add command line applications using the Apptainer container library provided by CSC.
87+
* [VS Code 1.78.2](./vscode.md) Code editor.
88+
* [Crypt4gh-gui](../sd_connect.md#sensitive-data-encryption-and-upload-for-analysis-up-to-100-gb) Encryption tool.
89+
* [Backup tool](./backup_sd_desktop.md) Help tool to automiatize backup and export in SD Desktop.
90+
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# VS Code
2+
3+
VS Code is a code editor redefined and optimized for building and debugging modern web and cloud applications.
4+
5+
VS Code 1.78.2 can be installed to a SD Desktop virtual machine with [SD software installer](./sd-software-installer.md).
6+
The installation creates a desktop button for VS Code
7+
8+
The VS Code installation does not include any extensions. However you can add them yourself.
9+
10+
On you own computer open VS Cone extension library:
11+
12+
* [https://marketplace.visualstudio.com/VSCode](https://marketplace.visualstudio.com/VSCode)
13+
14+
Once you have found the right extension, use the _Download Extension_ function to
15+
download the extension to your local computer as a _.vsix_ file.
16+
17+
Then use [SD Connect](https://sd-connect.csc.fi) to encrypt and upload the .vsix file to SD Connect.
18+
19+
Then in SD Desktop, refresh the DataGateway connection and copy the _.vsix_ file to your
20+
SD Desktop environment.
21+
22+
Finally open VS Code. Open the _extensions manager_ ( lowest icon, in the first column if the interface).
23+
In the Extensions manager, point the three dots ... to open the menu that contains function _Install from VSIX_
24+
Use that function to read in the .vsix file you imported.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Whisper
2+
3+
Whisper is a general-purpose speech recognition model. It is trained on a large dataset of
4+
diverse audio and is also a multitasking model that can perform multilingual speech recognition,
5+
speech translation, and language identification.
6+
7+
* [Whisper home page](https://github.com/openai/whisper)
8+
9+
The installation in SD Desktop is based on [WhisperDO](https://github.com/nicholasgcotton/WhisperDO)
10+
11+
After installation Whisper is available as a command line tool in SD Desktop.
12+
Sample command:
13+
14+
```text
15+
whisper audio.mp3 --model medium
16+
```
17+
18+

0 commit comments

Comments
 (0)