Skip to main content

RankChem project

Project description

project logo

ChemInterface for Reactivity Analysis

Project in the Practical programming in chemistry course EPFL CH-200

python GitHub jupyter license

🔥 What is RankChem about?

This repository provides the user with a package which will display an interactive interface where the user will be able to analyse the reactivity of meolecules based on their electrophilicity or nucleophilicity. The package leads the user to a streamlit homepage. Two features are available. The first one enables the user to visualize a molecule in 3D with the reactive site highlighted. The second feature ranks multiple molecules in the order of decreasing reactivity based on descriptors. Both these features were made using XTB calculations.

The developpers of this package are:

  • Ludovica Fracassi, 2nd year Bachelor student in Chemistry and Chemical engeneering at EPFL jhc github
  • Emma Kappeler, 2nd year Bachelor student in Chemistry and Chemical engeneering at EPFL jhc github

Before installing everything, let's first define electrophilicity and nucleophilicity!!

What is electrophilicity and nucleophilicity ?

Electrophilicity and nucleophilicity are fundamental concepts in organic chemistry that describe the reactivity of molecules. Electrophilicity refers to the ability of a molecule or ion to accept an electron pair, making it an electron-loving species (electrophile). Electrophiles typically have a positive charge, partial positive charge, or an electron-deficient atom, making them attracted to electron-rich regions. On the other hand, nucleophilicity describes the ability of a molecule or ion to donate an electron pair, making it an electron-rich species (nucleophile). Nucleophiles are usually negatively charged or have lone pairs of electrons, such as anions, amines, and alcohols. The interaction between nucleophiles and electrophiles drives many chemical reactions, particularly in organic synthesis, where nucleophiles attack electrophiles to form new bonds.

Now let's go through the steps required to use this package.

👩‍💻 Installation

❗ Before installing the package and all the dependencies, do not forget to create a new conda environment to prevent dependency conflicts and to keep the project isolated. This can be done by executing the following command:

conda create --name myenv python=3.10
conda activate myenv

Where myenv is the name of your environment.

The package runs on python 3.10 but supports python 3.8 through 3.10. RankChem can be installed using pip as followed:

pip install RankChem==1.1.5

The package can also be installed locally from source by running the following commands:

First, clone the repository from Github and go in the RankChem folder.

git clone https://github.com/fracaludo/RankChem.git
cd /to_dir/

Then, install the package using :

pip install .

Tha package can also be installed directly from Github via pip by executing the following command:

pip install git+https://github.com/fracaludo/RankChem.git

Required packages

In order to run the package correctly, the following packages need to be installed using the following commands.

❗ xtb-python only works for IOS and Linux. If you are using Windows, you should install Ubuntu. Further information is available on: https://ubuntu.com/desktop/wsl

Libblas and xtb-python are not pip installable, however, you can install them by running the following commands in your terminal:

conda install "libblas=*=*mkl"
conda install xtb-python

When installing the RankChem, the necessary dependencies should be installed automatically. However, if the dependencies are not installed as expected, please ensure you install the following packages by executing the following commands:

conda install -c conda-forge morfeus-ml
conda install -c conda-forge rdkit
conda install -c conda-forge pyvistaqt
conda install -c conda-forge numpy
conda install -c conda-forge py3Dmol
conda install -c streamlit
conda install -c stmol

Specifically, from these packages, the following subpackages are required:

import streamlit as st
from rdkit import Chem
from rdkit.Chem import AllChem, rdDistGeom
from morfeus import read_xyz, XTB
from stmol import showmol
import py3Dmol

🎥 How it works

This project has an interface based UI to interact with the functions. In order to use it, go to the directory where you cloned the repository and run the following commands in your terminal:

streamlit run app.py

The user then arrives to the RankChem Homepage where they can choose which feature they want to use.

OR just jump to the 🚥 Let's get started! section below and click on the streamlit badge.

homepage

The Highlight feature enables the user to input the smiles of a molecule and choose if nucleophilicity or electrophilicity is highlighted. The interface will then display the molecule in 3D with the chosen site highlighted. The user can also choose the visualiation style, the colour of the highlight and the number of iterations in order to get a more precise result. The Fukui values of each atom will also be displayed. An example of the input and output is shown below:

highlight

Lastly, the Ranking feature enable the user to input multiple smiles and again choose if nucleophilicity or electrophilicity is analysed. The interface will then return the molecules with highest: the most electrophile/nucleophile molecule, and lowest: the least electrophile/nucleophile molecule. Their corresponding descriptors values are also displayed. An example is shown below:

ranking

More information on the usage and limitations of the package can be found in our jupyter notebook based report 📓

🚥 Let's get started!

The streamlit interface can now finally be used!! ⚠️ currently not working due to conda environment.yml problems. In order to open the working interface, follow the steps descibed previously in your terminal.

Just click on the logo below ;)

Streamlit App

❗❗ Important

The package displays the wrong active sites and the ranking is often wrong. This, we think, is due to fukui dictionnaries/global descriptors inconsistencies from morfeus-ml or xtb-python. This issue is out of our reach. Sorry :(

🔎 References an documentation

Here is some useful reading on the packages that we used to create this project.

https://digital-chemistry-laboratory.github.io/morfeus/ https://github.com/digital-chemistry-laboratory/morfeus https://github.com/napoles-uach/stmol https://xtb-python.readthedocs.io/en/latest/index.html#

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

rankchem-1.2.5.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

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

RankChem-1.2.5-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file rankchem-1.2.5.tar.gz.

File metadata

  • Download URL: rankchem-1.2.5.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.14

File hashes

Hashes for rankchem-1.2.5.tar.gz
Algorithm Hash digest
SHA256 4d8fb457b847c6d10915755a8f60ff3081d4e5be078a19ae10d3fc677c18b65f
MD5 973b5f6942b5c444d70f1490e613c206
BLAKE2b-256 ed03bd1ec0b1c4fe013e32817a21eba0313c36a5279e31c00d577447a11e19f4

See more details on using hashes here.

File details

Details for the file RankChem-1.2.5-py3-none-any.whl.

File metadata

  • Download URL: RankChem-1.2.5-py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.14

File hashes

Hashes for RankChem-1.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 efbec09c730f3efd1909fd8c1c5c7cc3cef30ab95a79a136557fb8844bcade5d
MD5 9265f7945a5696b37f5ab9f9dafe4adf
BLAKE2b-256 c98a3598a958352b9025a617bcc0b313d5bd9e67801a01fb5d311cc72bbac328

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