Setting up the Custom Block

Modified on Thu, 09 Nov 2023 at 03:38 PM

These instructions are for the new Custom Block only, not for the legacy R or legacy Python blocks. For these blocks, please see the instructions at Setting up legacy R and Python blocks


Custom Block



Docker

Omniscope supports Docker containers. Docker containers are isolated environments with a pre-installed configuration which makes working with Custom Blocks a bliss. These containers are available for Windows, Linux, and Mac OS X. 

Not all Windows versions are supported, please check https://www.docker.com/ if your system is supported. If it is, we highly recommend using it as it will make your life much easier. With Docker containers, you do not need to install anything (except for Docker itself), Omniscope takes care of everything, and your Custom Blocks will just work. 


For more information please go here: https://help.visokio.com/a/solutions/articles/42000089057. If you choose to use Docker containers, you do not have to read this article any further.

Python

Please note that only Python 3 is supported. Also, Omniscope needs a Python package called Pandas in a version that is 2.0 or higher. It will install it itself, but if it is already installed on your system, and especially if that version is below 2.0, you will need to remove it. To do so, you can execute the following command:


python3 -m pip uninstall pandas


In order for this block to execute Python based scripts, recent Python installations are required.


In case Python was installed in a custom location that cannot be automatically discovered by Omniscope, it is possible to set the path to the executable manually in the admin area. 

After installing Python, you need to restart Omniscope for the changes to take effect.


Windows


Python can be downloaded from the Python website: https://www.python.org/downloads/.


Linux


On debian distributions, or distributions supporting apt-get, copy and paste the following line into the command line and press Enter:


sudo apt-get install python3 python3-pip


For systems that do not support apt-get, please open the package manager and look for an available python version. Alternatively python can be built from sources. The sources and help can be found on the Python website: https://www.python.org/downloads/.



Mac OS X


Standard installation:

Python can  be downloaded from the Python website: https://www.python.org/downloads/.


Homebrew installation:

Python can also be installed via Homebrew which can be  installed from the website https://brew.sh/. In order to  install python open the Terminal, copy and paste the relevant line into the command line and press Enter:



brew install python3




R


In order for this block to execute R based scripts, recent R installations are required. Omniscope supports R from version 3.4.4 onwards, but it is always recommended to install the newest version.


In case R was installed in a custom location that cannot be automatically discovered by Omniscope, it is possible to set the path to the executable manually in the admin area. 

After installing R, you need to restart Omniscope for the changes to take effect.

Windows


R can be downloaded from: https://cran.r-project.org/bin/windows/.



Linux

Linux users need to make sure the development package for libcurl and ssl/openssl is installed.


For Ubuntu, open the terminal, copy and paste the following line into the command line and press Enter:


sudo apt-get install r-base libcurl4-gnutls-dev libssl-dev libcurl4-openssl-dev


For different Linux distributions, please either open the package manager and look for an available R version, or download and install a package file from https://cran.r-project.org/bin/linux/.



Mac OS X


R can be downloaded and installed from https://cran.r-project.org/bin/macosx/


Troubleshooting for Mac OS X:

In case you have troubles installing packages, do the following:


Make sure you have the newest version of XCode installed via the Apple Appstore.

 

Open the Terminal, copy and paste the relevant lines into the command line and press Enter.

 

First, make sure that you don’t have any old GFortran compilers left on your system by removing any old installation with the following command:

sudo rm -r /usr/local/gfortran /usr/local/bin/gfortran


Then, download and install the newest GFortran compiler from this website:

https://gcc.gnu.org/wiki/GFortranBinaries#MacOS


Reinstall R.

 




Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article