> For the complete documentation index, see [llms.txt](https://grace1287986s-organization.gitbook.io/audioviz-ui-v2/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://grace1287986s-organization.gitbook.io/audioviz-ui-v2/installation.md).

# Installation

By clicking the tab in each page, you can get the information related to the title of the tab.

{% tabs %}
{% tab title="Packing Environment" %}
We use Docker to pack our analysis tool, if you don't have Docker, please download and install it.

* ***Windows*** download: [Windows Docker install link](https://hub.docker.com/)
* ***Mac*** download: [Mac Docker install link](https://docs.docker.com/desktop/install/mac-install/)

If you are experiencing trouble installing Docker, we also provide a web page tool with memory limitations. Please click the `Web Page Usage` tab to get more information.

{% endtab %}

{% tab title="Web Page Usage" %}

1. Create a [GitHub](https://github.com/) account. If you've already had a GitHub account, please sign in.

<figure><img src="/files/zSbl9CNisHD0e7BfL3bF" alt=""><figcaption></figcaption></figure>

2. Go to our [audioviz's github](https://github.com/Keycatowo/audioviz-webui). Change the branch to `cloud` branch.

<figure><img src="/files/c050sPckIHHOgqrjGuAW" alt=""><figcaption></figcaption></figure>

3. Create a fork of audioviz program to your own GitHub account. &#x20;

<figure><img src="/files/6FYeQ7ajVdKTFSf6Z3s8" alt=""><figcaption></figcaption></figure>

4. Open [Streamlit](https://streamlit.io/) and create an account.&#x20;

<figure><img src="/files/zER5HHsNERVSrRkFSICq" alt=""><figcaption></figcaption></figure>

5. After sign in, choose `Connect GitHub account`.

<figure><img src="/files/wuHRbKn5g2IERNSrBe5d" alt=""><figcaption></figcaption></figure>

6. Click the `New app` button to start creating your own app.

<figure><img src="/files/mouyC5Im2IeKZA8vejxq" alt=""><figcaption></figcaption></figure>

7. Give the authorization of your GitHub for audioviz's repository.

<figure><img src="/files/sVpnnIVs6HxgLXYbS3Sp" alt=""><figcaption></figcaption></figure>

8. Fill in the place where arrows are pointing. Then click the `Deploy` button and you can deploy your own audioviz program.

<figure><img src="/files/Ruo69BXg5CfG0rk46zgH" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Docker installation" %}

### **For Windows/Mac with Intel chip system:**

1. If you do not have an account of dockerhub, please register one first.

<figure><img src="/files/DQ5nkv0DpVmcVrLihrFN" alt=""><figcaption></figcaption></figure>

2. Click the `Download for Windows` button to download the dockhub. Run the `Docker Desktop Installer.exe` file for installation.

<figure><img src="/files/RIggSECutcW4rZmF0WfV" alt=""><figcaption></figcaption></figure>

3. Press OK for the configuration. For easy finding, it's also recommended to check the desktop icon.&#x20;

<figure><img src="/files/1fqhzX9QVUUXBeU4KAin" alt=""><figcaption></figcaption></figure>

4. It'll take some time for installation. After installation, click the `Close and restart` button to set up the environment.

<figure><img src="/files/OxWMRqkHAKCRGbUEkJa0" alt=""><figcaption></figcaption></figure>

### An example of Docker installation steps in Mac system with Apple silicon

1. Download the latest version of Docker Desktop from [Docker's site](https://docs.docker.com/desktop/install/mac-install/).
2. Open the downloaded file and drag the Docker.dmg file to your **Applications** folder.

<figure><img src="/files/vESRidENmuTnWfxGxcgz" alt=""><figcaption></figcaption></figure>

3. Open the Docker app from the Applications folder.
4. Type in your Mac's password when prompted.

<figure><img src="/files/vO465nZl66mZQQt28DLn" alt=""><figcaption></figcaption></figure>

5. After this, Docker will configure itself automatically.

<figure><img src="/files/rkP5wTnLbv10TnlIguRu" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Instructions for Start Running audioviz" %}

1. Open your Docker Desktop and you will see the following window:

<figure><img src="/files/tdc5HLne2NiwC78uZkR1" alt=""><figcaption></figcaption></figure>

2. Click the search bar.

<figure><img src="/files/07RVDThsWIhXAi6biUXf" alt=""><figcaption></figcaption></figure>

3. For <mark style="background-color:blue;">**Windows/Mac with Intel chip system**</mark>**:** Type to search for <mark style="background-color:blue;">**audioviz**</mark> and click the `Pull` button to pull down the package. For <mark style="background-color:purple;">**Mac with Apple silicon system**</mark>: Type to search for <mark style="background-color:purple;">**trangdulam/audioviz\_osx**</mark> and click the `Pull` button to pull down the package.

<figure><img src="/files/iYjKYdBJD07RweH2xGig" alt=""><figcaption></figcaption></figure>

4. Click the `Images` page. You can find the package of audioviz you've just pulled. Then click the triangular button to start running audioviz.

<figure><img src="/files/kpRjyAHh21saW5RRQ3cU" alt=""><figcaption></figcaption></figure>

5. Click the drop down menu of Optional settings.

<figure><img src="/files/nBU9zClbXNETyNKHRYqq" alt=""><figcaption></figcaption></figure>

6. For the connection ports, please type <mark style="background-color:red;">**8501**</mark> for usage. Then click the `Run` button.

<figure><img src="/files/APYDFSVtZPZ4ElQPAQjJ" alt=""><figcaption></figcaption></figure>

7. By clicking the port you've set above, you can open audioviz for audio analysis!

<figure><img src="/files/lE2uC3oHEfmOlnJRkav0" alt=""><figcaption></figcaption></figure>

If you want to terminate the program, please click the stop button.&#x20;

<figure><img src="/files/6HiP3DyQAuEkH4AaZe1q" alt=""><figcaption></figcaption></figure>

If you've already pull the package of audioviz, just follow `Step8` to `Step11` to run the program.
{% endtab %}

{% tab title="Error Handle Example" %}
If you've encounter the WSL problem, please follow the instructions in [this page](https://docs.microsoft.com/windows/wsl/wsl2-kernel) to set up your environment

<figure><img src="/files/kLJcRQURQzaS6iJ5imhf" alt=""><figcaption></figcaption></figure>

* An example of tackling the WSL problem

*Windows system*

1. Type `wsl --update` in the PowerShell of Windows system.
   {% endtab %}
   {% endtabs %}