Metadata-Version: 2.1
Name: bitbox
Version: 2024.3.dev2
Summary: Behavioral Imaging Toolbox
Project-URL: Homepage, https://github.com/Computational-Psychiatry/bitbox
Project-URL: Documentation, https://github.com/Computational-Psychiatry/bitbox/wiki
Project-URL: Issues, https://github.com/Computational-Psychiatry/bitbox/issues
Author-email: ComPsy Group <tuncb@chop.edu>
Maintainer-email: ComPsy Group <tuncb@chop.edu>
License-File: LICENSE
Keywords: behavior,body actions,computer vision,facial expressions,psychiatry,psychology
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.8
Requires-Dist: cvxpy
Requires-Dist: numpy
Requires-Dist: scikit-learn
Description-Content-Type: text/markdown

# Behavioral Imaging Toolbox

Bitbox is a free and open-source Python library including a comprehensive set of tools for the computational analysis of nonverbal human behavior. The provided tools enable analysis of face, head, and body movements, expressions, and actions from videos and images. Included algorithms and metrics have been validated using clinically vetted datasets and published extensively, therefore, can be reliably used by behavioral, social, and medical scientists in their human subject research. As we closely follow state-of-the-art in computer vision and machine learning, provided methodologies can also be relied upon by computer vision researchers and other engineers as well.

Please refer to our [Wiki](https://github.com/Computational-Psychiatry/bitbox/wiki) for further details.

## Installation

Before installing Bitbox, you need to install 3DI. If 3DI is not installed, you will receive an error when trying to use Bitbox. 3DI repository is located at [https://github.com/Computational-Psychiatry/3DI](https://github.com/Computational-Psychiatry/3DI).

To install Bitbox, follow these steps:

1. Clone the Bitbox repository:
    ```bash
    git clone https://github.com/Computational-Psychiatry/bitbox.git
    ```

2. Change to the Bitbox directory:
    ```bash
    cd bitbox
    ```

3. Install Bitbox using `python setup.py install`:
    ```bash
    python setup.py install
    ```

4. Set the environment variable `PATH_3DI` to indicate the directory in which 3DI was installed:

    - **Linux**:
      ```bash
      export PATH_3DI=/path/to/3DI/directory
      ```

    - **Windows** (Command Prompt):
      ```bash
      set PATH_3DI=C:\path\to\3DI\directory
      ```

    - **Mac**:
      ```bash
      export PATH_3DI=/path/to/3DI/directory
      ```

Now you are ready to use Bitbox!



