QBioCode is a suite of computational resources to support quantum applications in healthcare and life science data.

QBioCode has been tested and is compatible with Python versions 3.9, 3.10, and 3.11. While it might work on other versions, these are the officially supported and tested ones.

Getting Started

Prerequisites

Before you can run this project, you need to have python installed on your system

Option 1: Setting up a Python Virtual Enviroment (venv)

This is the standard way to create an isolated Python enviroment.

Steps:

1. Install pip (if you don't have it):

 python -m ensurepip --default-pip

or on some systems:

 sudo apt update
 sudo apt install python3-pip

2. Create a virtual enviroment:

   python -m venv venv

This command creatas a new directory named venv (you can choose a different name if you prefer) containing a copy of the Python interpreter and necessary supporting files. 3. Activate the virtual enviroment:

• On macOS and Linux:

  source venv/bin/activate

• On Windows (command promt):

  venv\Scripts\activate

• On Windows (PowerShell):

  .\venv\Scripts\Activate.ps1

Once the activated, you'll see (venv) at the beginning of your terminal promt.

4. Install project dependencies: Once the virtual enviroment is activated, you can install the required packages listed in the requirements.txt file:

pip install  -r requirements.txt

5. Deactivate the virtual enviroment (when you are done):

    deactivate

   This will return you to your base Python enviroment.

Option 2: Setting up a Conda Enviroment

1. Create the environment from the requirements.txt file. This can be done using anaconda, miniconda, miniforge, or any other environment manager.

conda create -n qbiocode python==3.11

• Note: if you receive the error bash: conda: command not found..., you need to install some form of anaconda to your development environment.

2. Activate the new environment:

conda activate qbiocode
pip install -r requirements.txt

3. Verify that the new environment and packages were installed correctly:

conda env list
pip list

qbiocode-profiler

The profiler relies on a config.yaml file for tis setting and paremeters. **To run the project via the command prompt, you must have a correctly formatted config.yaml.

config.yaml Structure

The config.yaml file should be a structured in YAML format. Please refer to the config.yaml file in this repository

Important:

• Ensure that the keys in your config.yaml file match the expected configuration parameters.
• The project will likely fail or behave unexpectedly if the config.yaml file is missing, incorrectly formatted, or contains incorrect values.

Running via command prompt

python qbiocode-profiler.py --config-name=config.yaml

Help

python qbiocode-profiler.py --help

Authors

Contributors and contact info:

• Bryan Raubenolt ([email protected])
• Aritra Bose ([email protected])
• Kahn Rhrissorrakrai ([email protected])
• Filippo Utro ([email protected])
• Akhil Mohan ([email protected])
• Daniel Blankenberg ([email protected])
• Laxmi Parida ([email protected])