gonylee/studio

Component based analytics studio on the web browser

Brightics Studio v1.1

Overview

Brightics Studio is a web-based data analysis workflow tool for data scientists.
Brightics Studio has an intuitive user interface and the interactive GUI will let you find potential insights from your data.
Brightics Studio supports an interface for analytics by wrapping popular python libraries such as scikit-learn and pandas.
Using Brightics Studio, both citizen data scientists and professional data scientists will be able to handle their projects.
Using the Brightics Toolkit, user interfaces for custom functions can be generated and they will be usable in the Brightics workflow.
Charts and report generators are also provided to visualize data in various ways.

Documentation

Please visit our web site http://www.brightics.ai

Getting started

Prerequisite

• macOS users have to install graphviz using Homebrew

brew install graphviz

• Some functions which interact with database need client libraries such as Oracle Instant Client

Download

In the beta phase, the releases and patches will probably be updated every week.
Download release files are available from github release or our web site http://www.brightics.ai/downloads

Installation

Execute the downloaded file. It will extract files automatically.

BrighticsStudio-\<version\>-\<os name\>.exe : for windows
BrighticsStudio-\<version\>-\<os name\>.sh : for linux and mac

Details of the directory is as follows:

/brightics-studio/brightics-server : core home
/brightics-studio/visual-analytics : GUI home
/brightics-studio/lib : external libs

Launch

You don't need to prepare anything before running it. Our releases contain all requirements in a package itself.
Go to unzipped directory and run.

start-brightics.cmd : for windows
start-brightics.sh : for linux and mac

Patch

If a new version is released, you should move these files to newer version of brightics-studio to maintain data and projects.

/brightics-studio/visual-analytics/brightics.db
/brightics-studio/brightics-server/data/*

Or download "BrighticsStudio-<version>-<os name>-patch" and run this from the location of Brightics Studio installation.

Run

Brightics Studio pops up on Chrome browser after launching start-brightics.cmd (or start-brightics.sh). Please go to http://127.0.0.1:3000 manually to use Brightics Studio if it does not pop up automatically.

Start from AWS Marketplace

Brightics Studio is now available from AWS Marketplace(https://aws.amazon.com/marketplace/pp/B07P4399PD).
It just takes only 1~2 minutes to setup EC2 and launch Brightics Studio.

Install additional packages

This section explain how to install some python packages to Brightics Studio python environment.

/brightics-studio/lib/python/python get-pip.py : This step is only needed once.
/brightics-studio/lib/python/Scripts/pip install <ANY_PACKAGES>

Development

Prerequisite

• JDK 1.8, 1.9 (64bit)
• Python 3.6.x (64bit)
• Node.js 8.11.2 (64bit)

Setting up the environment variables

for windows:

SET JAVA_HOME=<Your Java installation path>
SET PYTHON_HOME=<Your Python installation path>
SET NODEJS_HOME=<Your Node.js installation path>
SET PATH=%PATH;%PYTHON_HOME%\bin;%JAVA_HOME%\bin;%NODEJS_HOME%\bin

for linux-like systems:

export JAVA_HOME=<Your Java installation path>
export PYTHON_HOME=<Your Python installation path>
export NODEJS_HOME=<Your Node.js installation path>
export PATH=$PATH:$PYTHON_HOME/bin:$JAVA_HOME/bin:$NODEJS_HOME/bin

Most common cases you don't need to set above parameters because those projects automatically add paths during their installation process.

Build

Build a package with maven.

mvn clean package -DskipTests [Options]

When the build process is finished, a distribution will be created under build/target/dist directory.

Create python environment

    pip -r brightics-studio\lib\requirements.txt

Some of python packages need Microsoft Visual C++ Build Tools.
Please make sure Microsoft Visual C++ 14.0 installed when you run the setup command in windows.
Reference : Python wiki for WindowsCompilers

License

Visual Analytics(Web GUI) project is licensed under the terms of the Brightics Visual Analytics LICENSE, please check Notice below.
The others are licensed under the terms of the Apache 2.0 license.

Notice

Source codes of the Web GUI are not yet fully opened due to some license issues from its submodules.
The purpose of personal use for commercial or non-commercial is allowed but only the redistribution is prohibited.
See the documentation about this license for more details.
We are working hard to solve these issues and soon it will be public.

Contact us

If you like to use Brightics Studio, please let us know your usage and feedback.
Or you have questions while using Brightics Studio, don't hesitate and feel free to contact [email protected]