pyWBE 0.0.6
An open-source Wastewater-based Epidemiology Library in Python
License: MIT
Requires Python: >=3.9

<h1 align="center">pyWBE</h1> 

<h3 align="center">An open-source Wastewater-based Epidemiology Library in Python</h3>

<div align="center">
  <table>
    <caption><p style="font-weight:bold">Status Badges</p></caption>
    <tr>
      <th>Usage</th>
      <th>Continuous Integration</th>
      <th>Release</th>
    </tr>
    <tr>
      <td><img alt="PyPI - Python Version" src="https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11-blue"></td>
      <td><img alt="Test Status" src="https://github.com/illinoisdpi/pywbe/actions/workflows/tests.yml/badge.svg"></td>
      <td><img alt="PyPI - Python Version" src="https://img.shields.io/badge/pypi-v0.0.6-blue"></td>
    </tr>
    <tr>
      <td><img alt="PyPI - License" src="https://img.shields.io/badge/License-MIT-green"></td>
      <td><img alt="Documentation Status" src="https://img.shields.io/badge/Generate_Docs-passing-Green"></td>
    </tr>
    <tr>
      <td><img alt="GitHub Repo Stars" src="https://img.shields.io/github/stars/illinoisdpi/pywbe?style=social"></td>
      <td><img alt="Repo Status" src="https://img.shields.io/badge/Repo%20status-Active-Green"></td>
    </tr>
  </table>
</div>

## Online Documentation
Follow [this link](https://illinoisdpi.github.io/pywbe/) for a nicely-rendered version of this README along with additional tutorials for [using pyWBE](https://illinoisdpi.github.io/pywbe/). Keep reading for a installation guide and links to tutorials!

## Installing `pyWBE`

Installation steps coming up.

### `pip`
`pyWBE` is available on `PyPI` and can be installed using `pip`:

### Source
To install `pyWBE` from source for development, see our GitHub.

## Statement of Need

![Tests](https://github.com/illinoisdpi/pywbe/actions/workflows/tests.yml/badge.svg)

Wastewater-based epidemiology (WBE) is a dynamic tool used historically to monitor various pathogens and contaminants in communities, from viruses such as COVID-19, influenza, and RSV to challenges like opioid detection. With the COVID-19 pandemic, WBE's role as an early detection and monitoring system has grown significantly. However, despite its potential, the WBE field lacks a centralized computational library, leading to redundancies and inefficiencies in data handling and analysis.

Our mission is to address this void by launching `pyWBE`, a dedicated Python library catering to a broad range of WBE needs:

1. **Data Management**: Efficient tools for efficient data preparation and preprocessing, meta-data integration, eliminating redundancy, and adhering to the CDC's standardized data dictionaries.

2. **Geospatial Support**: Features to integrate wastewater data with social, demographic, and climate datasets at the administrative boundary level, offering a comprehensive perspective in relation to demographics, health metrics, and environmental indicators.

3. **Data Analytics**: Comprehensive tools for detecting patterns, tracing relationships among various pathogens and viral variants, and leveraging epidemiological models, converting wastewater data into valuable public health insights.

4. **Visualization and Reporting**: Tools for creating clear and informative visuals, emphasizing clarity and accuracy to prevent potential data misinterpretations.

5. **Data Interpretation**: Tools for unpacking the complexities of WBE metrics and transforming data into actionable knowledge while actively countering potential misinformation.

With the rising reliance on WBE for tracking a spectrum of challenges, from viruses to opioids, a toolkit like "pyWBE" is imperative. It promises to standardize practices, battle misinformation, and serve as an invaluable asset in training and workforce development. "pyWBE" seeks to empower the WBE community, ensuring that accurate, actionable, and standardized insights drive public health decisions.

## Quick Start
Coming soon

### Example Notebooks
Coming soon 

## *We will be uploading the functions soon. Thank you for visiting.