README.md

VizAble

VizAble is a web-based data visualization tool that generates accessible visualizations for all users, including people with visual impairments (low vision or blind). There are 2 ways that you can access to VizAble:

Web Application

You can access the web application version of VizAble by visiting the following link: Go to VizAble

Install Package from PyPI or GitHub

You can also install the VizAble package and run the application locally on your machine. Below are the instructions for installation and usage:

A. Prerequisites

Before getting started, ensure you have the following requirements in place:

1. Python Version: Ensure you have Python version 3.9 or higher installed. You can verify your Python version by running:

   python --version

2. Virtual Environment Setup: It's recommended to create and activate a virtual environment before installation. Below is an example of creating and activating a virtual environment using Python's built-in venv module. Note that this is just one example, and there are other options available for creating virtual environments:

   a. Create a virtual environment (replace env_name with your desired environment name):

   python -m venv env_name
   

   b. Activate the virtual environment:

   source env_name/bin/activate
   

B. Installation

You can install VizAble either from PyPI for the latest stable version or directly from GitHub for the latest development version:

1. Install the latest stable version from PyPI using pip:

   pip install -U VizAble
   

2. Or, install the latest development version from GitHub:

   pip install -U git+https://github.com/Rebekah-Chuang/VizAble.git
   

Usage

To run the VizAble application, execute the following command:

VizAble.run_app

Once executed, a link will be displayed in the terminal. You can open this link in your web browser to access the application.