A data science tool for correlating user data with noncovalent interaction (NCI) energies, using substituent effect patterns and statistical analyses to suggest the most likely NCI. Cation–π, anion–π, CH–π, and π–π interactions are currently available for analysis along with 54 differently substituted arenes and heteroarenes.
Citation: Pending
Version v3.3.1_beta (July 2023)
What this document covers:
- Software and Module Requirements
- Preparing Input Data
- Explanation of Code Input Options
- Running the Notebook
- Adding to/Using Custom Data Workbooks
Software Required:
- Jupyter Notebook
- Python3
Python Modules Required:
- pandas
- numpy
- plotly
- scipy.stats
All Python modules can be installed via pip or conda from the terminal:
pip install pandas
To automatically install all Python modules, run the setup script in the terminal:
pip install -r setup.txt
The NCI Diagnostic Tool takes input in excel (.xlsx) format (see Input.xlsx as an example). Two columns are required:
- Arene Fragment or Substituent
- Experimental Data
The input excel file must be in the same directory as NCI Analysis.ipynb Note: Additional data in the same excel sheet as input may lead to errors
Functional group names with data available for each energy type can be listed by running a function in the Jupyter Notebook prior to analysis
A list of functional group names for selected NCI interaction type will print onscreen. Copy the desired funcional group name EXACTLY AS PRINTED into your input excel file as needed.
NCI_reference_data # Name of NCI data workbook (Default: NAME-OF-DATA-TBD)
input_excel_workbook # Name of input excel workbook
input_excel_sheetname # Name of input excel sheet
interaction_type # Specify type of NCI interaction to analyze (Options: all (recommended), Cation-pi, Anion-pi, Anion-pi fixed, pi-pi, or CH-pi)
energy_type # Specify type of energy to analyze (Options: Total Interaction Energy, Electrostatic, Repulsion, Induction, or Dispersion)
This Toolkit is designed to accomodate the addition of custom data into the NCI reference workbook calculated by the user. The naming conventions for adding data are as follows:
The code only recognizes reference sheets named BA'd Library, ESP, Fixed Distance Anion-pi, and Hammett. DO NOT add/remove sheets OR change their names
For benzene substituents:
[FunctionalGroup]_benzene
For other heteroaromatics or other fragments:
[FunctionalGroup]
Data for each entry must be added to the corresponding column (e.g. Total Interaction Energy, Electrostatic, Repulsion, Induction, Dispersion). At least one of these columns must contain data.
IMPORTANT: DO NOT add/remove columns OR change their names
For code-related inquiries, contact [email protected]