Software Installation and Activation
Installation
OmicsBox is a desktop application and the installer can be downloaded here.
Windows
Once downloaded double click on the installer and follow the instructions. OmicsBox will be installed in C:\Users\[username]\AppData\Local\OmicsBox by default.
Install in unattended mode
.\OmicsBox_windows-x64_<version>.exe -q -dir "C:\OmicsBox" -console
<version> stands for the version number in the name of the installer you downloaded, with underscores instead of dots.
The parameters are:
-q run in unattended mode
-dir "C:\OmicsBox" set the installation path. We recommend setting a common path where all users have read/write permissions. This will allow the tool to update itself if there is an update when started. An alternative is to install it on each user's home folder. If this parameter is not set, the installation is done in the default installation path mentioned above.
-console see the installation progress in the terminal. Installation is done when you see the "Finishing installation ..." message.
Linux
Extract the installer from the folder, double click on the .sh file and follow the instructions. OmicsBox will be installed in /home/[username]/OmicsBox by default.
From the terminal
unzip OmicsBox_unix_<version>.zip
sudo chmod +x OmicsBox_unix_<version>.sh
./OmicsBox_unix_<version>.sh
<version> stands for the version number in the name of the installer you downloaded, with underscores instead of dots.
MacOS
Once downloaded double click on the .dmg file and the installer will open (Figure 2).
Double click on the OmicsBox installation App.
If Apple cannot check the OmicsBox installer for malicious software a message will be displayed (Figure 3). If there is no Open button, try opening the OmicsBox installer App using right-click and open. You should see the same warning message, but this time there should be an option to open.
Click Open and follow the instructions to complete the installation. OmicsBox will be installed in /Applications/OmicsBox by default
Figure 1: Download OmicsBox Installer
Figure 3: Apple Message
Activation
When OmicsBox starts for the first time, it asks you to sign in to your OmicsBox account (see OmicsBox Login Dialog). Since OmicsBox 4.1, sign-in comes before activation. After you sign in, OmicsBox looks up the subscriptions linked to your account email:
- If exactly one subscription is found, OmicsBox links it to your account automatically, shows a confirmation message and restarts to apply it.
- If several subscriptions or none are found, the Activation dialog opens (Figure 4).
OmicsBox can be fully activated with a subscription key, which can be obtained from the BioBam website. A subscription activates the modules of the software that have been purchased. Additionally, it gives access to cloud services, such as analyzing data in the BioBam Cloud infrastructure, updates and support. More details about the advantages of a subscription can be found on our website.
The Activation dialog provides the following options:
- Subscription key field: A drop-down list with the subscriptions found for your account. Subscriptions already linked to your account are listed first and marked "(linked)". You can also paste a subscription key in this field.
- Find my subscriptions: Looks up the subscriptions linked to your account email again and updates the list.
- Link: Validates the selected subscription key and links it to your OmicsBox account.
- Request Trial Key: Opens the BioBam website to request a free trial of a subscription.
- Limited Mode: Starts OmicsBox without activation. Use this mode if you only need to open OmicsBox files and will not run any analyses. The only available options are related to loading and visualizing OmicsBox projects.
- Network License: Switches the dialog to network license activation (see Network License).
- Proxy Settings: Opens the proxy configuration. The software requires access to the Internet for activation.
OmicsBox restarts whenever the subscription key changes. To review or change the subscription key later, use File > Manage License.
Figure 4: Activation dialog of OmicsBox: Full or Limited Mode
OmicsBox Login Dialog
Every user of OmicsBox signs in with an individual account.
When a user links a subscription, the account is associated with that subscription as a user of the subscription. The associated users can then be reviewed and managed by the subscription owner. With this, we offer a more advanced subscription usage management for Cloud Units consumption and control on who can use the software. The subscription owner can limit the access to Cloud Units by user for the shared OmicsBox installation while seeing how the consumption evolves. This can be managed from the BioBam Account website.
The login account and credentials (email and password) are the same as the ones used on the BioBam Account website. If you do not have a BioBam Account you can create one from within OmicsBox using the "Sign up" option.
The Sign In dialog allows you to do the following:
- Sign-Up: Create a new user with a new password. This option is possible if a user with the same email address does not exist. The password has to fulfil the indicated security requirements. The sign-up process has to be completed with a verification code sent via email. Make sure to check the classified and spam folders in your email account.
- Sign-In: Authenticate with your login by providing your account email and password.
- Password Recovery: This option allows to set a new password for an existing account, by confirming a verification code sent via email. Make sure to check the classified and spam folders in your email account.
- Manage License: Opens the Activation dialog to manage the subscription used to activate OmicsBox.
To switch to another account, use File > Sign Out. OmicsBox clears the subscription key and restarts. After you sign in again, OmicsBox looks up the subscriptions of the new account as described in Activation.
Settings are stored per account. Wizard parameter values, OmicsBox bookmarks and recently used cloud folders are saved separately for each account that signs in on the same computer. Installation-wide settings, such as the workspace, temporary folder, number of threads and proxy settings, are shared by all accounts. After an update, the first account that signs in keeps the existing settings.
Network License
OmicsBox can also be activated with the license server. Various clients can share a pool of licenses on a license server in the local network. To activate a network license, click Network License at the bottom left of the Activation dialog, enter the license server address in Server IP / Domain Name and, if you own one, the Cloud Key, and click Activate. The cloud key allows to use CloudBlast and CloudIPS, all the other cloud features are already available without a key.








