Skip to main content

pKaPredict project

Project description

Project Logo

Coverage Status

pKaPredict


📦 Overview

pKaPredict is a cheminformatics tool that predicts the acid dissociation constant (pKa) of chemical compounds from their SMILES strings. The package is designed to be easily pip-installable and modular, making it ideal for cheminformatics applications. The package combines RDKit generated molecular descriptors with a pre-trained LGBMRegressor model for fast, reproducible predictions. The workflow includes training data preprocessing, descriptor generation, model loading, prediction, and result visualization.

💡 Main Functions :

Functions used to train the machine learning model on a training dataset

clean_and_visualize_pka Cleans the training dataset by removing duplicates and missing values; also provides basic visualizations for data exploration.

RDKit_descriptors Transforms a DataFrame of SMILES into molecular descriptors, used for training the model.

plot_data Creates scatter plots comparing predicted vs. experimental pKa values to evaluate model performance and choose the most adapted model for this usage.

Core functions for predicting pKa from user-provided SMILES inputs

load_model Loads the pre-trained LightGBM model optimized for pKa prediction.

smiles_to_rdkit_descriptors Converts a user-provided SMILES input into a vector of RDKit molecular descriptors.

predict_pKa Takes molecular descriptors as input and returns predicted pKa values using the loaded model.

👩‍💻 Installation

  1. Clone the repository:
git clone https://github.com/anastasiafloris/pKaPredict.git
cd pKaPredict
  1. Create and activate the conda environnement:

If your project includes an environment.yml file:

conda env create -n pkapredict_env -f environment.yml
conda activate pkapredict_env

If not, you can create one manually:

conda create -n pkapredict_env python=3.10 -y
conda activate pkapredict_env
  1. Install the package:
pip install pKaPredict
  1. Install jupyter lab:
pip install jupyterlab

🍏 For macOS users (⚠ required for LightGBM to work):

  1. Install the system library libomp:
brew install libomp

If brew is not installed, follow the instructions here: https://brew.sh

  1. The package is yours 🎁:

Run the test_package.py file in a python or jupyter environment to predict the pKa of a molecule of your choice, using its SMILES string.

🪪 License

This project is licensed under the MIT License.
You are free to use, modify, and distribute it with proper attribution.

📗 References

The dataset used in this project is the test_acids_bases_descfinal_nozwitterions.csv file from the cbio3lab repository.
It was originally extracted from the Harvard Dataverse.

👯‍♀️ Authors

This project was completed as part of the EPFL course Practical Programming in Chemistry.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pkapredict-0.1.5.tar.gz (4.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pkapredict-0.1.5-py3-none-any.whl (147.2 kB view details)

Uploaded Python 3

File details

Details for the file pkapredict-0.1.5.tar.gz.

File metadata

  • Download URL: pkapredict-0.1.5.tar.gz
  • Upload date:
  • Size: 4.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for pkapredict-0.1.5.tar.gz
Algorithm Hash digest
SHA256 709d31394906e2d7e0bfa3a5b490957c121c1113300f576094e33d9e4bdd6ea9
MD5 56abc29afbd0963dbd70f76158b1bcbf
BLAKE2b-256 92633d662387a8cecc55ad4e0fd0209dd59af44752a4d870732432d2b350be54

See more details on using hashes here.

File details

Details for the file pkapredict-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: pkapredict-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 147.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for pkapredict-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8a022b81718d1ec3cef3a7ffdb2d23ce48b8cc0ac40e66d79d6104db763c050e
MD5 0435e56c93117290509812839d51d8ca
BLAKE2b-256 b35ffbf2b84a5705fd850cbf99e356b9653886a6527c42383d954f24e462e116

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page