Installation

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

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

• Mac download: Mac Docker install link

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.

Web Page Usage

1. Create a GitHub account. If you've already had a GitHub account, please sign in.

2. Go to our audioviz's github. Change the branch to cloud branch.

3. Create a fork of audioviz program to your own GitHub account.

4. Open Streamlit and create an account.

5. After sign in, choose Connect GitHub account.

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

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

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

Docker installation

For Windows/Mac with Intel chip system:

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

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

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

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

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

1. Download the latest version of Docker Desktop from Docker's site.

2. Open the downloaded file and drag the Docker.dmg file to your Applications folder.

3. Open the Docker app from the Applications folder.

4. Type in your Mac's password when prompted.

5. After this, Docker will configure itself automatically.

Instructions for Start Running audioviz

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

2. Click the search bar.

3. For Windows/Mac with Intel chip system: Type to search for audioviz and click the Pull button to pull down the package. For Mac with Apple silicon system: Type to search for trangdulam/audioviz_osx and click the Pull button to pull down the package.

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.

5. Click the drop down menu of Optional settings.

6. For the connection ports, please type 8501 for usage. Then click the Run button.

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

If you want to terminate the program, please click the stop button.

If you've already pull the package of audioviz, just follow Step8 to Step11 to run the program.

Error Handle Example

If you've encounter the WSL problem, please follow the instructions in this page to set up your environment

• An example of tackling the WSL problem

Windows system

1. Type wsl --update in the PowerShell of Windows system.