> For the complete documentation index, see [llms.txt](https://docs.zingg.ai/0.4.0/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zingg.ai/0.4.0/contributing/settingupzingg.md). # Setting Zingg Development Environment The following steps will help you set up the Zingg Development Environment. While the steps remain the same across different OS, we have provided detailed instructions for Ubuntu OS. Below examples have been created using Ubuntu 22.04.2 LTS Make sure to update your ubutu installation sudo apt update *** ***Step 0 : Install Ubuntu on WSL2 on Windows*** * Install wsl: Type the following command in **Windows PowerShell**. ``` wsl --install ``` * Download Ubuntu from **Microsoft Store**, **Ubuntu 20.04 LTS** * Configure Ubuntu with a **username** and **password** * Open **Ubuntu 20.04 LTS** and start working ``` sudo apt update ``` * Follow this [tutorial](https://ubuntu.com/tutorials/install-ubuntu-on-wsl2-on-windows-10#1-overview) for more information. *** ***Step 1 : Clone the Zingg Repository*** * Install and SetUp Git: **sudo apt install git** * Verify : **git --version** * Set up Git by following the [tutorial](https://www.digitalocean.com/community/tutorials/how-to-install-git-on-ubuntu-20-04). * Clone the Zingg Repository: **git clone ** ***Note :-*** It is suggested to fork the repository to your account and then clone the repository. *** ***Step 2 : Install JDK 1.8 (Java Development Kit)*** * Follow this [tutorial](https://linuxize.com/post/install-java-on-ubuntu-20-04/) to install Java8 JDK1.8 in Ubuntu. * For example: ``` sudo apt install openjdk-8-jdk openjdk-8-jre javac -version java -version ``` *** ***Step 3 : Install Apache Spark -*** * Download Apache Spark - from the [Apache Spark Official Website](https://spark.apache.org/downloads.html). * Install downloaded Apache Spark - on your Ubuntu by following [this tutorial](https://computingforgeeks.com/how-to-install-apache-spark-on-ubuntu-debian/). * For example for 3.5.0: ``` wget https://www.apache.org/dyn/closer.lua/spark/spark-3.5.0/spark-3.5.0-bin-hadoop3.tgz tar -xvf spark-3.5.0-bin-hadoop3.tgz rm -rf spark-3.5.0-bin-hadoop3.tgz sudo mv spark-3.5.0-bin-hadoop3 /opt/spark ``` Make sure that spark version you have installed is compatible with java you have installed, and Zingg is supporting those versions. ***Note :-*** Zingg supports Spark 3.5 and the corresponding Java version. *** ***Step 4 : Install Apache Maven*** * Install the latest maven package. * For example for 3.8.8: ``` wget https://dlcdn.apache.org/maven/maven-3/3.8.8/binaries/apache-maven-3.8.8-bin.tar.gz tar -xvf apache-maven-3.8.8-bin.tar.gz rm -rf apache-maven-3.8.8-bin.tar.gz cd apache-maven-3.8.8/ cd bin ./mvn --version ``` *** ***Step 5 : Update Env Variables*** Open .bashrc and add env variables at end of file ``` vim ~/.bashrc export SPARK_HOME=/opt/spark export SPARK_MASTER=local[\*] export MAVEN_HOME=/home/ubuntu/apache-maven-3.8.8 export PATH=$PATH:$SPARK_HOME/bin:$SPARK_HOME/sbin:$MAVEN_HOME/bin export ZINGG_HOME=/zingg/assembly/target export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64 Save/exit and do source .bashrc so that they reflect source ~/.bashrc Verify: echo $PATH mvn --version ``` where \ will be a directory where you clone the repository of the Zingg. Similarly, if you have installed spark on a different directory you can set **SPARK\_HOME** accordingly. ***Note :-*** If you have already set up **JAVA\_HOME** and **SPARK\_HOME** in the steps before you don't need to do this again. *** ***Step 6 : Compile the Zingg Repository*** * Run the following to Compile the Zingg Repository - ``` git branch (Ensure you are on main branch) mvn initialize * Run the following to Compile the Zingg Repository - **mvn initialize** and * **mvn clean compile package -Dspark=sparkVer** ``` ***Note :-*** Replace the **sparkVer** with the version of spark you installed, For example, **-Dspark=3.5** and if still facing error, include **-Dmaven.test.skip=true** with the above command. ***Note :-*** substitute 3.3 with profile of the spark version you have installed. This is based on profiles specified in pom.xml *** ***Step 7 : If had any issue with 'SPARK\_LOCAL\_IP'*** * Install **net-tools** using **sudo apt-get install -y net-tools** * Run command in the terminal **ifconfig**, find the **IP address** and paste the same in **/opt/hosts** IP address of your Pc-Name *** ***Step 8 : Run Zingg to Find Training Data*** * Run this Script in terminal opened in zingg clones directory - **./scripts/zingg.sh --phase findTrainingData --conf examples/febrl/config.json** *** **If everything is right, it should show Zingg Banner.** --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.zingg.ai/0.4.0/contributing/settingupzingg.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.