Skip to content

SigmanGroup/NCI-Diagnostic-Toolkit

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NCI Diagnostic Toolkit

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 and module requirements

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

Preparing Input Data

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 Naming

Functional group names with data available for each energy type can be listed by running a function in the Jupyter Notebook prior to analysis Screen Shot 2023-08-02 at 2 28 48 PM

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.

Explanation of Code Input Options

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)

Adding to Current/Using Custom Data Workbooks

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:

Excel Data Worksheets

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

Naming Data Entries Within Probe Groups

For benzene substituents:

[FunctionalGroup]_benzene
  • Ex: Data in this row Screen Shot 2023-08-02 at 2 37 33 PM will be indentified as 1,2diMe in the excel input

For other heteroaromatics or other fragments:

[FunctionalGroup]
  • Ex: Data in this row Screen Shot 2023-08-02 at 2 38 25 PM will be indentified as 2OMe_styrene in the excel input

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

Contact Information

For code-related inquiries, contact [email protected]

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Jupyter Notebook 99.5%
  • Python 0.5%