Science Score: 49.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 2 DOI reference(s) in README -
✓Academic publication links
Links to: acs.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (16.5%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: Shualdon
- License: bsd-3-clause
- Language: Fortran
- Default Branch: main
- Size: 79.1 MB
Statistics
- Stars: 31
- Watchers: 2
- Forks: 14
- Open Issues: 13
- Releases: 0
Metadata Files
README.md
QupKake - Predict micro-pKa of organic molecules
QupKake combines GFN2-xTB calculations with graph-neural-networks to accurately predict micro-pKa values of organic molecules. It is part of the paper: QupKake: Integrating Machine Learning and Quantum Chemistry for micro-pKa Predictions.
Requirements
- Python >= 3.9
- pytorch >= 2.0
- pytorch_geometric >= 2.3.0
- pytorch_lightning >= 2.0.2
- rdkit >= 2022.03.03
- xtb == 6.4.1
Installation
We recommend using conda to install QupKake.
Option 1
Clone the repository:
bash
git clone https://github.com/Shualdon/QupKake.git
cd qupkake
Create a conda environment from the environment.yml file:
bash
conda env create -f environment.yml
conda activate qupkake
This will create a conda environment with all the dependencies installed.
Install the package:
bash
pip install .
Option 2
Create a conda environment:
bash
conda create -n qupkake python=3.9
conda activate qupkake
Clone the repository and install using pip:
bash
git clone https://github.com/Shualdon/QupKake.git
cd qupkake
pip install .
This will install the package and all the rest of the dependencies.
xtb Installation
Due to bugs in the conda version of xtb, it should be installed from source, and the path to the executable should be set up before running QupKake:
bash
export XTBPATH=/path/to/xtb/executable
Follow the xtb documentation for more information.
The linux binaries of xtb come with the package and will be used by default if the neither the conda package or the $XTBPATH environment variable are set up.
Usage
Qupkake can be used as a Python package or as a command line tool. This gives the user the flexibility to use the package in their own code or to use it as a stand-alone tool.
Command line
Once installed, QupKake can be used as a command line tool. The general syntax for running the program is:
bash
$ qupkake <input_type> <input> <flags>
The general flags that can be used are:
```bash
-r, --root: Root directory for processing data. Default: data
-t, --tautomerize: Find the most stable tautomer for the molecule(s) Default: False
-mp [N], --multiprocessing [N]: Use Multiprocessing. True if used alone. If followed by a number, it will use that number of subprocesses. (default: False) ```
Qupkake has 2 types of inputs that can be used to run the program:
1. A single molecule as a SMILES string:
bash
$ qupkake smiles "SMILES"
Specific flags for this input type are:
```bash
-n, --name: molecule name. Default: molecule
-o, --output: output file name (SDF with pKa predictions). Default: qupkake_output.sdf ```
2. A CSV or SDF file containing multiple molecules
bash
$ qupkake file <filename>
Specific flags for this input type are: ```bash -s, --smiles_col: column name for SMILES strings. Default: smiles
-n, --name_col: column name for molecule names. Default: name
-o, --output: output file name (SDF with pKa predictions). Default: qupkake_output.sdf ```
Python package
TBA
Citation
If you use this package in your research or application, please cite the following paper:
Bibtex
bibtex
@article{qupkake,
title={QupKake: Integrating Machine Learning and Quantum Chemistry for micro-pKa Predictions},
DOI={10.26434/chemrxiv-2023-gxplb},
journal={ChemRxiv},
publisher={Cambridge Open Engage},
author={Abarbanel, Omri and Hutchison, Geoffrey},
year={2023}
}
Copyright
Copyright (c) 2023, Omri D Abarbanel, Hutchison Group, University of Pittsburgh, PA, USA.
Acknowledgements
Project based on the Computational Molecular Science Python Cookiecutter version 1.1.
Owner
- Name: Omri Abarbanel
- Login: Shualdon
- Kind: user
- Twitter: omriab
- Repositories: 6
- Profile: https://github.com/Shualdon
PhD candidate in the @hutchisonlab at the University of Pittsburgh
GitHub Events
Total
- Issues event: 5
- Watch event: 12
- Issue comment event: 7
- Pull request event: 1
- Fork event: 2
Last Year
- Issues event: 5
- Watch event: 12
- Issue comment event: 7
- Pull request event: 1
- Fork event: 2