Overview
=========

The project **PK4ADI** stands for "PK for anesthetic depth indicators", which is designed to help analysis the performance
of the possible indicators for the medical occasions. 

Intro
-------

The PK was first proposed by the Dr. Warren D. Smith and his team in 1996 :cite:`smith1, smith2`, it could be represented in a mathematical 
expression :math:`P_k`.The :math:`P` is short for the probability, and the subscript :math:`k` indicates the relation with 
Kim's equation. :math:`P_k` has been one of the most popular tools to evaluate the anesthetic depth indicators since.
At the very beginning, :math:`P_k` could only be calculated and compared with the MS Excel macro files :cite:`Philip`.

Project **PK4ADI** is designed to make this tools suitable for the developing demands of the data analysis.
In fact, the project is consisted of three sub-projects: **PK4ADI** for Python, **PK4ADI** for R, and 
**PK4ADI calculator** for GUI which is based on **PK4ADI** for Python.
All these sub-projects provide easy-use APIs for :math:`P_k` calculatation as well as :math:`P_k` comparison.


This document is intented to help pepple use the **PK4ADI** for Python. 
The document of  **PK4ADI** for R could be find at this link.
And The document of  **PK4ADI calculator** for GUI could be find at this link.

Key Features
--------------

The key features of **PK4ADI** for Python includes:

- Fully communication with the original research group: During the development of teh package, we have informed Dr. Warren D. Smith and got helpful suggestions from him.
- Reimplementation of the MS Excel macro in Python: The pk4adi package offers a Python-based implementation of the PK tools :cite:`Philip`.
- Easy-to-use APIs: The pk4adi package makes it easy to interact with the PK tools and calculate Prediction probability for anesthetic depth indicators.
- More types checks and error alerts: The pk4adi package provides more transparent and more friendly tips for the users.
- Favourable for automation coding: The pk4adi package is designed to act as a middleware for automated coding processes.
- Open Source and Collaboration: The project is fully open source on GitHub, encouraging collaboration and contributions from the community to improve the functionality and reliability of the package.