> For the complete documentation index, see [llms.txt](https://bisque.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bisque.gitbook.io/docs/readme.md).

# Welcome

## Welcome to Official BisQue Documentation

<figure><img src="/files/afemUYIboGrpdoSo4i5g" alt="Github Banner"><figcaption></figcaption></figure>

## What is BisQue

[BisQue](https://bisque2.ece.ucsb.edu/client_service/) is an open-source web-based platform that supports **data storage for petabytes, ML based data analysis and reproducible workflows**, and **visualization**.

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

BisQue is specifically designed to provide researchers with organizational and quantitative analysis tools for up to 5D image data. Users can extend BisQue by creating their own modules that take advantage of cutting edge machine learning algorithms. BisQue’s extensibility stems from two core concepts: an open web-based architecture and a flexible metadata facility. Together, these empower researchers to create, develop, and share novel multi-modal data analyses.

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

### BisQue Service: Jump right in

Follow our handy guides to get started on the basics as quickly as possible:

{% content-ref url="/pages/wYy5XcJpBcrTb4AqgNq9" %}
[Data Storage](/docs/bisque-service/data-storage.md)
{% endcontent-ref %}

{% content-ref url="/pages/NNU5ajH1jvQQrtPFZ82G" %}
[Data Visualization](/docs/bisque-service/visualization.md)
{% endcontent-ref %}

{% content-ref url="/pages/07J5lcuF8UPycUWzMh9T" %}
[Data Analysis / Modules](/docs/bisque-service/analysis.md)
{% endcontent-ref %}

## Developers

**Deploy** your own instance of BisQue with `Docker` or `Kubernetes`, and **Build** your own module using our BQ Module Generator Command Line Interface (CLI).

{% content-ref url="/pages/mEnjLrXJnH9t7mDWHHq4" %}
[Installing, Running, and Deploying BisQue](/docs/running-bisque-service/installing-running-and-deploying-bisque.md)
{% endcontent-ref %}

{% content-ref url="/pages/wI7yhCeUKVkzKMsW0Dsb" %}
[Docker Installation](/docs/running-bisque-service/docker-installation.md)
{% endcontent-ref %}

{% content-ref url="/pages/hMPIEwfgQ0g55kwPXQfH" %}
[Install Python BQAPI](/docs/bisque-api/install-python-bqapi.md)
{% endcontent-ref %}

<figure><img src="/files/M36Z4OMU0C9m9dSmmSe9" alt="Contributors"><figcaption></figcaption></figure>

<p align="center"><strong>Acknowledgements</strong>: This material is based upon work supported by the U.S. National Science Foundation under Grant No. 2411453. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.</p>